Guidelines : WordPress

Statut : Recommendation (REC)

Cette présente convention rassemble les bonnes pratiques WordPress en production appliquées par l'agence web Alsacreations.fr. Elle a pour but d'évoluer dans le temps et de s'adapter à chaque nouveau projet.

Structure de projet

On utilise

  • Composer pour installer WordPress et ses extensions.
  • WordPlate qui fonctionne avec viteJs.
  • Tailwind en tant que framework CSS (facultatif).
  • Timber pour utiliser Twig dans les templates (facultatif).

Environnement de développement

👉 On utilise Docker

  • Par défaut, on part d’une base MySQL locale. Il est possible d’utiliser une base MySQL “partagée” accessible à distance, attention cependant à la synchronisation d’informations et de fichiers (options, réglages de plugins activés…).
  • Utiliser define('WP_ENVIRONMENT_TYPE','staging'); puis wp_get_environment_type()
  • Utiliser define('WP_DEBUG',true); pour activer le mode debug

Git

On versionne les fichiers :

  • .env.example
  • composer.lock
  • package.json
  • le thème développé pour le projet
  • les extensions développées pour le projet
  • les fichiers de configuration
  • les fichiers de traduction du thème (dossier /languages) ou de l’extension (dossier de l’extension)

On ne versionne pas :

  • .env (sauf exception)
  • WordPress lui-même (car installé/mis à jour par composer)
  • les extensions tierces (car installé/mis à jour par composer)
  • les fichiers uploads, update et vendor

👉 Le fichier README.md à la racine du projet doit contenir toutes les informations pour ré-installer le site rapidement en production.

Configuration de base

Sécurité, utilisateurs

  • 👉 Supprimer l’utilisateur admin et l’utilisateur avec l’ID 1. Créer un utilisateur de niveau administrateur avec identifiant spécifique différent de “admin”.
  • Créer un ou plusieurs utilisateurs de niveau éditeur pour les intervenants (doit être différent du nom de domaine pour des raisons de sécurité), ayant accès juste aux fonctionnalités utiles.

Thème

  • 👉 On privilégie de démarrer avec un starter thème épuré https://underscores.me/ ou https://github.com/timber/starter-theme lorsque l’on utilise Timber.
  • 👉 Supprimer les autres thèmes livrés par défaut.
  • Il est plus rapide de développer le thème dans WordPress plutôt que de passer par une phase d’intégration statique.
  • On évite d’utiliser un thème acheté car cela sous-entend qu’on ne pourra pas tout mettre en place dans ces guidelines et qu’on ne maîtrise pas son contenu (code, extensions, évolutions). Si toutefois cela arrive, utiliser le principe de thème enfant pour ne pas modifier le thème parent, qui pourrait être mis à jour par la suite.
  • Modifier le logo sur le formulaire de connexion admin (voir snippets).

Intégration du thème

Outils de vérification (linters)

La liste des linters recommandés est décrite par les guidelines Visual Studio Code. Les extensions spécifiques WordPress / PHP recommandées sont :

Automatisation

Avec viteJs (présent dans WordPlate)

Moteur de template

Timber (présent dans notre structure-type avec Docker)

Framework CSS

On privilégie, dans cet ordre, les frameworks CSS suivants :

Nommage HTML, CSS et PHP

Voir Guidelines HTML et CSS

  • Ne pas utiliser les classes CSS générées par WordPress qui sont spécifiques à une installation précise et ne sont pas réutilisables.
  • Les classes spécifiques des wrapper des menus du type .menu-nom-de-mon-menu
  • La majorité des classse générées par body_class() ou post_class()
  • Pour le chargement des fichiers CSS et JavaScript on utilise la configuration de WordPlate avec Vite.js
  • Placer add_action() et add_filter() après la fonction liée.
  • Utiliser la dernière notation pour les tableaux PHP $array = []; et non $array = array();.
  • Toutes les chaînes de caractères d’un thème doivent pouvoir être traduites. Il faut donc les entourer dans la bonne fonction gettext ( __(), _n(), _x() ), couplées à un text-domain cohérent en fonction du contexte (thème, thème enfant, extension, ...)
  • Découper le thème de manière cohérente (boucles à part, etc.) pour pouvoir utiliser get_template_part() correctement
  • Tout ce qui ne fait pas partie intégrante du thème et/ou optionnel doit être décliné sous forme d'extension

Hiérarchie de fichiers et documentation

👉 Utiliser l’auto-chargement des fichiers PHP du thème par WordPress (selon slug de la catégorie, du Custom Post Type, etc).

Voir aussi

À prévoir dans le thème

👉On ne nomme/préfixe pas le thème ou ses classes/fonctions par alsa_ mais plutôt par le nom du projet.

La structure standard est :

assets (dir)
      - css (dir)
      - images (dir)
      - js (dir)
inc (dir)
template-parts (dir)
      - footer (dir)
      - header (dir)
      - navigation (dir)
      - page (dir)
      - post (dir)
404.php
archive.php
comments.php
footer.php
front-page.php
functions.php
header.php
index.php
page.php
README.txt
rtl.css
screenshot.png
search.php
searchform.php
sidebar.php
single.php
style.css

Theme Check permet de vérifier si le thème correspond aux standards (ne fonctionne pas avec Timber).

Traductions

Voir https://www.alsacreations.com/article/lire/1837-wordpress-theme-internationalisation.html

functions.php

⚠️ Le fichier functions.php fonctionne différemment des autres fichiers “template”, lors de la création d’un thème enfant par exemple, il n’est pas simplement écrasé, mais chargé avant le thème parent. Les deux fichiers déclarant des fonctions cohabitent, et il serait dommage de ne pas pouvoir écraser une fonctionnalité, ou de tomber sur une erreur PHP car une fonction est déclarée deux fois. Il faut donc prendre l’habitude de déclarer TOUTES les fonctions ainsi :

if ( ! function_exists( 'nomdutheme_nom_de_la_fonction' )  {
    function nomdutheme_nom_de_la_fonction() {
        // do something
    }
}
add_filter('filter_name', 'nomdutheme_nom_de_la_fonction');

👉 Idéalement le fichier functions.php du thème inclut d’autres scripts PHP dédiés pour organiser le code :

  • actions.php
  • filters.php
  • menu.php
  • theme-setup.php
  • etc.

Exemple de fichier functions.php

/**
 * Menus/Sidebar/Theme options definitions
 */
require_once 'includes/theme-setup.php';

/**
 * Filters used to alter front-end rendering
 */
require_once 'includes/menu-filters.php';

/**
 * Actions & filters
 */
require_once 'includes/actions.php';
require_once 'includes/filters.php';

/**
 * Parent theme overload
 */
require_once 'includes/inc-pages-functions-updated.php';
require_once 'includes/cnrs-functions.php';

Shortcodes

Lors de la création d’un shortcode avec paramètres, il est conseillé de ne plus utiliser la fonction extract (voir https://core.trac.wordpress.org/ticket/22400). Tout shortcode ajouté doit faire l’objet d’un guide écrit pour l’utilisateur final.

Voir https://capitainewp.io/formations/developper-theme-wordpress/shortcode/ et https://kinsta.com/fr/blog/shortcodes-wordpress/

Gutenberg / éditeur wysiwyg

Blocs sur-mesure

Nous utilisons les blocs ACF. Cette technique permet de ne rendre modifiable que des champs spécifiques (champ texte, image, colorpicker, etc.) et avoir les fonctionnalités d'ACF (champ relationnel, taxonomies, etc.).

Dans le cas où on utilise un thème acheté et que les fichiers php ne sont pas utilisables, on se tournera vers une extension afin de générer des "patterns" Gutenberg sur-mesure.

Formulaires

Extensions

👉 Installation : utiliser composer avec le nom du plugin, préfixé par “wpackagist-plugin”, par exemple composer require wpackagist-plugin/wp-migrate-db

👉 Toute fonctionnalité développée sur-mesure pour le projet se fait dans le cadre d’une extension propre à activer/désactiver.

Modèles d’extension à utiliser

Obligatoires

  • WP fail2ban si hébergement interne : permet de signaler les erreurs d’identification à fail2ban+iptables pour bannir les IP tentant du bruteforce ; n’utilisez alors pas d’extension pour changer l’url de wp-admin.
  • WP Migrate Lite pour migrer les données de local > dev > recette > prod (et inversement), à désinstaller par sécurité après mise en production.
  • W3 Total Cache ou WP Fastest Cache ou WP Super Cache : cache/compression de contenu pour améliorer les temps de réponse.
  • SecuPress pour améliorer le score global (permissions de fichiers, bonnes pratiques).
  • Notre plugin Kiwiplate Setup Theme, et/ou mettre en place les actions suivantes (extensions + snippets de code).

Recommandées selon usage

  • Disable emojis : désactiver les appels de scripts externes vers WordPress (RGPD).
  • Disable comments : désactiver les commentaires sur les articles/pages/médias, au choix (très propre).
  • ACF : ajouter des champs riches aux posts / pages / Custom posts.
  • Duplicate Post : créer du contenu rapidement en dupliquant d'un simple clic un article, une page, ou un custom post.
  • Ninja Forms : génération de formulaires. Partiellement accessible.
  • Polylang : traduction (remplace WPML).
  • SEOPress : SEO, ou Yoast (rajoute une grosse surcouche de pub très intrusive dans l'admin).
  • Filebird : File Manager (s’ajoute dans la galerie de médias) : créer des dossiers. Attention, il faut prendre la version premium pour créer des dossiers illimités.
  • Photo gallery (Galerie de médias, photos et vidéos) + riche en fonctionnalités que la galerie native (img s’ouvrent dans une popup, slider, bouton de téléchargement, création de groupes de galeries, etc…). N’est pas accessible : fenêtre modale qui ne prend pas le focus, pas d’attributs aria, bouton de fermeture non accessible.
  • Job Manager : Offres d’emploi.
  • Members : Droits et utilisateurs.
  • Megamenu : Menu de navigation.
  • Tarteaucitron || Cookie Notice : bannières cookies, code non accessible (boutons qui n’en sont pas, etc.).
  • Adminimize : personnaliser l’aspect de l’admin en fonction des niveaux des utilisateurs. || Hook natif : supprimer les items du menu (pour un rôle spécifique, vérifier le rôle avec fonction current_user_can).
  • Peters-login-redirect : redirection des utilisateurs après connexion. || Hook natif
  • Relevanssi : améliore les résultats de recherche par critères de pertinence.
  • User Switching : switcher facilement d’utilisateur.
  • Simple Page Ordering : ordonner les pages, et autres CPT ordonnés, par simple glisser/déposer, sans avoir besoin de rentrer dans chaque page.
  • Multiple Domain Mapping on Single Site pour faire correspondre différentes Pages (d’accueil) à plusieurs domaines ou sous-domaines.
  • Custom Login : personnaliser la page de login. || Tuto avec Hooks natifs
  • WP All Export : exporter les données au format CSV/XML (fonctionne avec ACF, The Events Calendar) fonctionne aussi pour l’import avec WP All Import
  • Admin Columns : ajouter/modifier des colonnes dans l'interface d'administration
  • Utiliser SVG dans WordPress - 2 extensions

E-commerce

  • WooCommerce est le plugin le plus actif (communauté, support) à l’heure actuelle. Il propose des feuilles de style par défaut, un système de coupon, gestion des stocks automatisé, gestion des e-mails client avancés, plein de hooks partout.
  • WOOF : Filtres plus riche en fonctionnalités que ceux de WooCommerce natif
  • Tickera Vente de billets, compatible avec WooCommerce.

Sécurité

  • User Name Security supprime les mentions de l’utilisateur (id et username) dans body_class(), entre autres choses.

  • SF Author URL control personnalise le “author” et le slug utilisateur pour sécuriser et personnaliser les URL des pages auteur.

  • Créer un ou plusieurs utilisateurs de niveau éditeur pour les intervenants (doit être différent du nom de domaine pour des raisons de sécurité), ayant accès juste aux fonctionnalités utiles, ne pas utiliser de compte admin par défaut pour toutes les personnes car cela permet l'installation d'extensions.
  • Compléter le fichier wp-config.php avec les valeurs de https://wordplate.github.io/salt/
  • Toujours utiliser les nonces pour éviter les CSRF, s’il faut développer des modules admin et/ou pour les utilisateurs identifiés sur le site.
  • Désactiver l’édition du thème et des plugins en ligne dans wp-config.php define('DISALLOW_FILE_EDIT', true);
  • Surveiller si le thème / les extensions utilisées font l’objet d’une faille sur wpscan
  • Ajouter le script pour enlever l'avertissement à la connexion qui permet d’indiquer que l’identifiant est le bon mais pas le mot de passe.

Développement

  • Query Monitor affiche les requêtes SQL exécutées et leur performance ainsi que les fichiers templates utilisés.

Ajouter le support de Gutenberg pour les CPT

Si le projet nécessite d’utiliser Gutenberg, penser à ajouter "show_in_rest" => true et "supports" => ['editor'] dans la déclaration des CPT.

Ajout des fonctionnalités essentielles dans des mu-plugins

Toutes les fonctions de base, sur lesquelles un non-administrateur ne doit pas avoir la main doivent passer par des extensions indispensables, ou mu-plugins (mu = must use). Elles ne peuvent être désactivées par l'interface web. C'est le cas notamment du renommage de fichiers dès l’upload dans la bibliothèque de médias, mais également du retrait des indices lors des erreurs de connexion au back-office (admin).

Quelques MU Plugins bien utiles : https://gitlab.com/ArmandPhilippot/mu-plugins

function no_wordpress_errors() {
    return __( 'Something is wrong !', 'text-domain' );
}
add_filter( 'login_errors', 'no_wordpress_errors' );

Performance

👉 Mettre en place un plugin de cache/compression/minification (voir extensions)

Recette

👉 On utilise wp-migrate-db pour exporter les contenus en adaptant les URLs développement vers recette.

👉 Ne pas laisser indexer ce site par Google, en ajoutant une identification HTTP (par exemple avec .htaccess).

  • Mise en place d’un webhook Gitlab possible pour auto-pull les derniers commits git.
  • Checklist de qualité https://wpaudit.site

Mise en ligne

👉 On utilise wp-migrate-db pour exporter les contenus en adaptant les URLs développement/recette vers production.

  • Autoriser l’indexation par les robots à la mise en production (dans la configuration) et retirer du fichier .htaccess Header set X-Robots-Tag "noindex,nofollow" s'il est présent.
  • Modifier l’adresse e-mail du compte administrateur.
  • Activer le cache.
  • Vérifier que toutes les anciennes URLs de développement ont disparu de la base.
  • Modifier les constantes WP_ENVIRONMENT_TYPE à production et WP_DEBUG à false.

Si l'hébergement est mutualisé et ne permet de pointer dans le dossier /public, activer la réécriture avec un fichier .htaccess à la racine :

RewriteEngine on
RewriteRule ^(.*)$ /public/$1 [L]

Maintenance

On peut utiliser WP-CLI pour opérations pratiques en ligne de commande.

Forcer la mise à jour par téléchargement direct dans wp-config.php define('FS_METHOD' 'direct');

Désactiver le warning d'update WordPress pour les non-administrateurs

if ( !current_user_can( 'edit_users' ) ) {
    add_action('admin_menu','wphidenag');
    function wphidenag() {
        remove_action( 'admin_notices', 'update_nag', 3 );
    }
}

Désactiver les notifications de mise à jour pour les non-admins

function hide_update_notice_to_all_but_admin_users()
{
    if (!current_user_can('update_core')) {
        remove_action( 'admin_notices', 'update_nag', 3 );
        remove_action('load-update-core.php','wp_update_plugins');
        add_filter('pre_site_transient_update_plugins','__return_null');
        echo '<style>#setting-error-tgmpa>.updated settings-error notice is-dismissible, .update-nag, .updated, .core-updates { display: none; }</style>';
    }
}
add_action( 'admin_head', 'hide_update_notice_to_all_but_admin_users', 1 );

Environnement sans Docker

Installer PHP

Pour pouvoir exécuter composer en ligne de commande https://www.php.net/downloads.php

Installer Composer

Suivre les instructions de https://getcomposer.org/download/

Sur macOS pour faire en sorte que la commande composer soit disponible partout :

mkdir -p /usr/local/bin
mv composer.phar /usr/local/bin/composer

Installer WordPlate avec Composer

WordPlate https://github.com/wordplate/wordplate

composer create-project --prefer-dist wordplate/wordplate superprojet

Modifier le fichier .env avec les coordonnées de la base de données MySQL.

Installer les plugins WordPress

Utiliser composer avec le nom du plugin, préfixé par “wpackagist-plugin”, par exemple composer require wpackagist-plugin/wp-migrate-db

Développer le thème

Exploiter webpackmix intégré : npm install

Optionnel: npm i concurrently -D

// Package.json
"scripts": {
    "serve": "php -S localhost:8000 -t public/",
    "build": "...",
    "dev": "...",
    "devstart": "concurrently \"npm run serve\" \"npm run dev\""
  },

Tâches :

  • Démarrage du serveur php : npm run serve
  • Démarrage du serveur dev (browsersync, css, js) : npm run dev
  • Minification/compilation : npm run build

Optionnel : démarrage des deux en même temps: npm run devstart

Si cross-env n'est pas installé npm install cross-env -g