10 conseils pour faciliter la maintenance de WordPress

En tant que développeur WordPress ayant travaillé sur différents types de projets, j'aimerais discuter de certains des points douloureux que j'ai personnellement rencontrés lors de la prise en charge d'un site Web WordPress existant pour des modifications ou des corrections de bogues. Les conseils et suggestions répertoriés dans cet article ont pour but de minimiser voire de supprimer ces douleurs.

Pourquoi une bonne maintenance de WordPress est importante

La plupart du temps, les sites Web ne sont pas une affaire « définie une fois et laissée seule », et cela est vrai pour tous les sites, pas seulement ceux de WordPress. De temps en temps, vous devrez faire face à des modifications, des mises à jour ou des corrections de bogues, dont votre développeur préféré s'occupera. Cependant, dans certains cas, vous devrez peut-être compter sur un certain nombre de développeurs différents tout au long de la durée de vie de votre site Web.

Dans ce dernier cas, les choses ne se passent souvent pas bien pour le développeur entrant, surtout si les développeurs précédents n'ont pas respecté les meilleures pratiques lors de la gestion de leurs tâches de maintenance.

Voyons quelques-uns des points les plus importants à prendre en compte dans vos futurs travaux de maintenance sur les projets WordPress afin de faciliter la vie de votre prochain développeur et lui faire aimer travailler sur votre site. De toute évidence, faciliter le travail de votre développeur est également susceptible d'économiser des heures de travail et de l'argent dans le processus, ce qui est toujours un bon argument de vente pour vos clients potentiels.

1. Sauvegardez-le !

Cela peut sembler trop évident, mais la première chose est la première ! Vous devez sauvegarder votre site WordPress correctement et régulièrement.

C'est l'une des choses les plus fondamentales à faire même si vous n'apportez aucune modification à votre site pour le moment. Vous pouvez soit le faire manuellement en récupérant tous les fichiers ainsi que le vidage de la base de données et en le stockant dans un endroit sécurisé, soit vous pouvez utiliser une option de sauvegarde automatisée, grâce à un plugin de sauvegarde WordPress. Il existe de nombreux plugins gratuits et payants que vous pouvez trouver dans le référentiel de plugins WordPress. Vous pouvez également faire bon usage de l'option de sauvegarde au niveau du serveur, car la plupart des hébergeurs proposent des options de sauvegarde. C'est quelque chose que vous devez vérifier auprès de votre hébergeur.

Avec des sauvegardes régulières, vous avez la tranquillité d'esprit que votre site sera à nouveau opérationnel après un plantage ou une erreur. Cela peut également aider votre nouveau développeur à résoudre les problèmes sans trop de tracas, en particulier si vous essayez de corriger un bogue que vous soupçonnez avoir pu se produire lors de la maintenance dans le passé. Des sauvegardes régulières devraient aider vos nouveaux développeurs à identifier et à résoudre les problèmes persistants, qui se sont produits des mois ou des années avant qu'ils ne prennent en charge le projet.

2. Installez votre site WordPress localement

Je ne suis pas fier d'admettre que j'ai moi-même commis cette erreur à mes débuts, et depuis, j'ai remarqué que de nombreux développeurs effectuaient des modifications directement sur le serveur distant. À moins que vous ne craigniez d'avoir des données sensibles et tous les fichiers du site à la merci de votre développeur, vous devriez éviter cette erreur pour de bon. Il est très inefficace de faire des allers-retours entre la machine locale du développeur et le serveur après chaque modification.

Même s'il s'agit d'un petit changement, comme une modification mineure pour changer un peu de texte sur votre site, le développeur doit accéder au fichier/dossier correspondant dans le client FTP (si vous utilisez FTP pour les téléchargements de fichiers), attendez les fichiers à télécharger et espérons qu'il n'y aura pas d'échecs de connexion FTP occasionnels. N'oublions pas que certains sites Web WordPress ont trop de données pour être déplacés pratiquement, sans perdre trop de temps et de bande passante. Et, une fois que tout a été téléchargé avec succès, ils doivent ensuite accéder au navigateur et actualiser la page qui, encore une fois, dépend de la vitesse et de l'état du réseau/serveur à ce moment-là. Il peut sembler que nous parlons de simples minutes et secondes qui peuvent être économisées à chaque modification, mais au cours de votre projet, ces minutes pourraient représenter des heures de travail inutiles.

Les modifications sont beaucoup plus rapides si vos développeurs ont installé le site sur leur machine locale : ils n'auront qu'à effectuer les modifications, actualiser la page, et le tour est joué. Même s'ils vivent dans une grotte sans aucune connexion Internet, ils peuvent toujours travailler et télécharger leurs modifications ultérieurement.

Que se passe-t-il si vous avez des données sensibles qui vous préoccupent ou s'il existe des raisons légales qui vous empêchent de partager toutes vos données avec les développeurs ? Dans ce cas, vous pouvez préparer des données fictives spécifiquement à cette fin. Vous pouvez également conserver ces données de côté pour une maintenance future.

3. Allez Git

L'une des meilleures choses qui se soit produite dans le monde du développement de logiciels est l'aube du contrôle de version en ligne. J'aborde ce point car de nombreux sites fonctionnent encore avec la méthode cPanel/FTP traditionnelle pour gérer les fichiers. Soit ils ne savent pas à quel point le contrôle de version est simple, soit ils le savent mais hésitent à l'implémenter en raison de l'effort de configuration initial. Cependant, ce n'est en fait pas beaucoup de travail, et c'est tout sauf une tâche difficile.

Le contrôle de version présente de nombreux avantages en matière de gestion de fichiers, notamment le suivi des modifications par divers auteurs, l'annulation facile des modifications, la possibilité d'avoir des branches distinctes pour chaque tâche indépendante afin de s'assurer que les modifications de chaque tâche n'interfèrent pas avec les autres.

Vous devez installer Git sur un serveur externe, qui est la plupart du temps pré-installé par votre hébergeur. Vous aurez peut-être besoin de quelqu'un ayant une certaine expertise sur les serveurs pour lancer le référentiel et configurer le flux de travail, ce dont je ne vais pas parler ici car cela dépasse le cadre de cet article.

Et pour ne pas mentionner, vous n'êtes pas réellement « git'ing » si vous n'utilisez pas de branches ! Créez au moins deux branches pour le développement et la production afin que les développeurs puissent faire tout le travail sur la branche de développement, tester le site, puis si tout va bien, poussez vers la branche de production en vous assurant que rien ne va mal sur le site en direct.

4. Supprimez les fichiers, le code et les plugins inutiles

Il est courant de laisser des fichiers et des plugins qui ne sont plus nécessaires. Cela devient pénible une fois que les fichiers s'accumulent au fil du temps tout au long du cycle de vie de votre site Web. Si votre développeur ne s'est pas soucié de supprimer les fichiers indésirables qui ont été ajoutés au fil du temps, il est difficile de savoir d'où ils viennent et s'ils sont actuellement utilisés par une partie du site ou non. Cela provoque un mal de tête supplémentaire car le site doit être testé à nouveau pour s'assurer que rien ne s'est cassé après la suppression de ces éléments suspects.

Cela peut être éliminé en supprimant immédiatement les fichiers indésirables par le développeur correspondant qui y a travaillé. Vous pouvez insister sur cette pratique auprès de tous vos développeurs.

Outre les fichiers PHP et les plugins, les fichiers multimédias inutilisés peuvent également remplir votre dossier wp-content au fil du temps, ce qui peut causer des problèmes à vos développeurs lorsqu'ils travaillent avec des fonctionnalités liées aux médias. Vous pouvez trouver divers plugins pour simplifier cette tâche. Un exemple est Media Cleaner.

Le plugin comporte une corbeille interne, y déplaçant temporairement les fichiers pour vous assurer que les fichiers ne sont pas réellement utilisés. une fois cochées, vous pouvez les supprimer définitivement. Assurez-vous de suivre le point numéro 1 de cet article (c'est-à-dire sauvegarder) avant de nettoyer l'un de vos fichiers.

5. Commenter

Vous connaissez probablement le mème de programmation qui ressemble à ceci : lorsque le code a été écrit, il a été compris par l'auteur qui l'a écrit, ses collègues et Dieu. Après un certain temps, seuls l'auteur et Dieu savaient ce qu'il fait, et maintenant seul Dieu sait ce qu'il fait - à moins que l'auteur n'ajoute des commentaires appropriés !

Certains développeurs peuvent être réticents ou carrément paresseux lorsqu'il s'agit de commenter, mais c'est une pratique incontournable dans un bon environnement de développement. Cela réduit le temps consacré aux modifications et aux corrections de bogues qui, autrement, seraient consacrés par les nouveaux développeurs ou même par le même développeur à déterminer ce que fait un bloc de code particulier.

Des commentaires doivent être ajoutés chaque fois que la fonction/classe ou le bloc de code n'est pas quelque chose d'évident, prenez la fonction suivante par exemple :

 function stripWhiteSapaces(str) { … Return str; }

Le nom de la fonction ci-dessus parle de lui-même et l'utilisateur n'a pas besoin d'aller à l'intérieur de la fonction pour voir comment cela fonctionne, il ne fait qu'un seul travail, en supprimant les espaces blancs - c'est tout ! Donc, dans ce cas, les commentaires peuvent ne pas être nécessaires.

Mais, par exemple, s'il existe une fonction qui accepte plusieurs paramètres et renvoie une liste filtrée de messages, alors ce n'est pas quelque chose d'évident comme le précédent. Il devrait y avoir des commentaires décrivant les paramètres et leurs types. Il peut également être nécessaire de décrire les blocs de code à l'intérieur de cette fonction.

Pour une vérification rapide, vous pouvez prendre un fichier du noyau WordPress et voir comment les experts WordPress l'ont commenté. Ou, pour des informations plus détaillées, vous pouvez vous référer au guide officiel de WordPress qui illustre bien cela.

6. peluchage

Le peluchage est une autre fonctionnalité intéressante qui applique des règles sur la façon dont nous écrivons du code, et parfois corrige le formatage du code lui-même, ce qui est à la fois cool et utile. La plupart des IDE utilisés aujourd'hui sont livrés avec des options de peluchage, que vous pouvez encore améliorer ou personnaliser en ajoutant diverses configurations de peluchage.

Par exemple, lorsque vous utilisez Visual Studio Code comme IDE, VS Code utilise le linter PHP officiel ( php -l ) pour les diagnostics du langage PHP. Vous pouvez configurer des règles/restrictions pour chaque langue séparément (c'est-à-dire PHP, JavaScript, CSS, etc.). Vous pouvez consulter les normes de codage WordPress pour plus de détails.

• https://make.wordpress.org/core/handbook/best-practices/coding-standards/php/
• https://make.wordpress.org/core/handbook/best-practices/coding-standards/javascript/

Une fois que vous avez une configuration de peluchage, vous devez l'appliquer. Tous vos développeurs actuels et futurs doivent intégrer cette configuration de lint à leurs IDE afin que leur code respecte également les mêmes règles/restrictions. Sinon, une grande partie de vos efforts seront vains.

7. Dénomination des variables et des fichiers

Concevoir une norme traitant de la façon dont les choses sont nommées. Cela inclut les noms de fonctions/classes, les noms de variables, les noms de fichiers et même les noms de médias/images s'ils font partie du modèle, car cela aidera également à comprendre à quoi ils servent.

Considérez certains des points essentiels:

1. Évitez les noms sans ambiguïté
2. Soyez bref si possible
3. Parfois, il est vraiment utile d'ajouter le « type » au nom du fichier. Par exemple, si c'est une icône, vous pouvez avoir quelque chose comme BlackArrowIcon.png ou si c'est une grande image d'arrière-plan, cela peut être quelque chose comme FrontYellowBG.jpg. Ou s'il s'agit d'un fichier de code, il est parfois très facile de savoir à quoi correspond ce fichier lorsque vous travaillez avec plusieurs fichiers ouverts dans différents onglets de l'IDE. Par exemple, s'il existe une classe avec des fonctions d'assistance, il sera utile qu'elle s'appelle HelperClass.php au lieu de Helper.php.

Pour plus d'informations, consultez la section Conventions de dénomination du guide des meilleures pratiques WordPress.

8. Débogage WordPress

Le débogage peut prendre beaucoup de temps et a tendance à occuper une part importante du temps de développement total, en particulier lorsqu'il s'agit de modifications ou de corrections de bogues. Cela signifie que vous devez noter si vos développeurs le font de la manière la plus efficace possible. La plupart des développeurs sont enclins à le faire en var_dump manuellement les variables dans une partie de la page Web, ce qui n'est pas la méthode la plus efficace. Cela peut également causer des maux de tête aux développeurs qui rejoindront le projet plus tard, car ils se retrouveront avec des lignes de code inutiles ici et là si le code de débogage n'est pas correctement nettoyé une fois le travail terminé.

Il existe quelques plugins pour vous aider dans cette tâche de débogage. Voici quelques exemples de plugins de débogage populaires pour WordPress.

• Débogueur KintName
• Barre de débogage
• Moniteur de requête

9. Avoir un meilleur CSS

En matière de développement Web, le style avec CSS est l'une des activités les plus élémentaires. Malheureusement, cela signifie qu'il est souvent négligé et reçoit moins d'attention que JS, PHP, etc. Mais, croyez-le ou non, CSS peut causer énormément de problèmes s'il n'est pas correctement architecturé lorsque vous essayez d'ajouter ou de modifier quelque chose à l'avenir, sauf si votre site est basique et petit.

Si vous souhaitez en savoir plus sur les raisons pour lesquelles cette technique de style relativement basique est sujette à des problèmes, vous pouvez Google pourquoi CSS est ennuyeux, ou vous pouvez en savoir plus sur les 5 choses les plus ennuyeuses avec CSS.

Voici quelques conseils rapides de ma part sans beaucoup de détails :

• Appliquer une bonne pratique de nommage. Utiliser une méthodologie de nommage comme BEM (Block Element Modifier)
• Évitez le style en ligne. Utilisez plutôt des feuilles de style externes.
• Essayez de proposer des modèles réutilisables communs chaque fois que possible, sans simplement gonfler les styles chaque fois que nécessaire.
• Divisez les styles en plusieurs fichiers en fonction des fonctionnalités ou des zones du site Web. Si vous craignez qu'un nombre plus élevé de fichiers de style n'affecte les performances de chargement, vous pouvez résoudre ce problème en utilisant un bon plugin de mise en cache qui regroupera plusieurs fichiers en un seul fichier.
• Utilisez le préprocesseur CSS tel que SASS, LESS, etc.

10. Obtenez des commentaires des développeurs actuels

En dernier lieu, et pour compléter la liste, vous pouvez obtenir des commentaires de vos développeurs sur les problèmes auxquels ils ont été confrontés lorsqu'ils travaillaient sur votre site. Ils pourraient être en mesure de donner de bons conseils car ce sont eux qui se sont salis les mains sur votre site. Ils peuvent également signaler des défauts ou du code sale laissé par les développeurs précédents.