Nous parlons souvent de l’importance d’écrire du code de qualité lorsqu’il s’agit de créer des thèmes ou modules WordPress (ou même des blocs personnalisés pour Gutenberg 😉 ). Cependant, ce n’est pas seulement une question de professionnalisme et de fierté. Pratiquement n’importe quel site peut se briser en raison d’un code de mauvaise qualité, ce qui pourrait nuire gravement à votre réputation professionnelle.

Heureusement, ce que signifie ” qualité ” a été distillé dans les normes de codage WordPress. Celles-ci vous aideront à vous assurer que votre code est à jour et vous donneront une sorte de feuille de route à suivre lorsque vous travaillez sur des projets importants.

Dans ce billet, nous examinerons plus en détail les normes de codage de WordPress. Nous présenterons également la version GitHub des standards, et expliquerons pourquoi vous voudrez peut-être les utiliser comme ressource. Cependant, avant cela, parlons un peu de la qualité du code !

Une lecture rapide (et amicale) sur la recherche d’un code de haute qualité

Nous sommes prêts à parier que vous êtes quelqu’un qui est très fier de ce qu’il fait. Tout du moins, si vous vous dites développeur, c’est une bonne idée d’agir comme tel. Vous avez peut-être le sweat à capuche mystique et une myriade d’autres clichés à portée de main, mais pouvez-vous dire que votre qualité de codage est à la hauteur de votre ambition ?

La réalité, c’est que peu importe où vous en êtes, il y aura toujours des améliorations que vous pourrez apporter. En résumé, vos efforts pour fournir le meilleur travail possible vous mèneront habituellement au cycle suivant :

  1. Vous identifiez (ou avez identifié) un aspect de votre code qui n’est pas conforme à vos normes.
  2. Grâce à une période d’apprentissage et de mise en œuvre, vous améliorez vos capacités.
  3. Vous identifiez un autre domaine d’amélioration que vous pourriez apporter.

Imaginez une courbe en cloche, avec vos pires compétences tracées vers la gauche et vos meilleures compétences vers la droite. Vous devriez constamment regarder vers la gauche et choisir les éléments les plus fragiles de votre code à travailler.

Cela déplacera toute la courbe en cloche vers la droite et fera en sorte que d’autres aspects deviennent les nouvelles choses à travailler. Cette pratique s’appelle la technique ‘Inchworm’ et sert de moyen discipliné d’évolution constante de vos capacités. La meilleure nouvelle est que les développeurs WordPress ont un avantage lorsqu’il s’agit de mettre en œuvre cette technique.

Les mesures que WordPress prend pour vous guider vers de bonnes pratiques de codage

S’efforcer de développer les zones les plus faibles est un noble objectif, et un coup de pouce en cours de route sera toujours le bienvenu. Naturellement, les principaux développeurs de WordPress ont tout intérêt à s’assurer que la communauté a une courbe d’apprentissage peu profonde lorsqu’elle crée pour la plate-forme. Si WordPress était difficile à coder, il ne serait pas adopté par autant de développeurs.

Pour commencer, considérez comment WordPress lui-même est codé. Il est pratiquement cousue par des hooks, ce qui signifie que vous pouvez implémenter les fonctionnalités de base dans chaque projet, sans introduire de problèmes ésotériques. Vous pouvez également voir cette position développeurs friendly dans la façon dont les modèles sont utilisés pour assembler les mises en page, et même dans les commentaires complets contenus dans chaque fichier PHP.

En fait, WordPress a une telle réputation dans ce domaine que les utilisateurs réguliers ouvrent souvent un éditeur de code et bricolent dans le back-end de leurs propres sites. Il y a aussi le Codex officiel, qui regorge de documents de référence sur la façon d’obtenir pratiquement tout dans WordPress.

En ce qui concerne les développeurs, le seul document dont vous aurez peut-être besoin pour vous assurer que votre code est de haute qualité (et garder les problèmes potentiels au minimum) – ce sont les normes de codage officielles.

Présentation des normes de codage officielles de WordPress

Le Manuel du contributeur du noyau offre beaucoup de choses à digérer sur la question du développement du noyau de WordPress. Cependant, il contient également les normes de codage officielles, ce sur quoi nous allons nous concentrer ici.

Comme vous l’avez peut-être compris, ces normes contiennent les lignes directrices pour l’engagement du code dans le noyau de WordPress. Bien que nous ayons parlé des raisons pour lesquelles ils ne devraient pas nécessairement s’appliquer au développement de thèmes et de plugins, ils seront toujours utiles dans ces situations également.

En bref, vous utiliserez les standards officiels pour écrire un code qui valide et n’introduit aucune erreur de base. Revoyons rapidement chaque série :

  • PHP. Cette vaste collection de normes, relatives à l’indentation, au style des accolades, au formatage des instructions SQL, et bien plus encore, est sans doute l’ensemble le plus important pour les utilisateurs de WordPress.
  • HTML. Étant donné la réduction relative de la complexité, le HTML comporte quelques entrées de moins que les autres langages. Néanmoins, des éléments importants tels que l’indentation et les balises à fermeture automatique sont représentés ici.
  • CSS. Après PHP, le CSS est le langage le plus important pour le style. Il y a beaucoup de choses à regarder dans cet ensemble, bien qu’il y ait des instructions plus générales que des éléments spécifiques.
  • JavaScript. JavaScript est, à juste titre, le plus dense de tous les standards de codage ici, en raison de son implémentation naissante dans WordPress. En fait, vous pouvez considérer qu’il s’agit d’un miroir des normes de codage PHP, d’autant plus qu’il prend de l’importance au fil du temps.

Une fois que vous aurez passé un peu de temps avec eux, vous remarquerez que même les normes les plus complètes sont encore facilement digestes. C’est une bonne nouvelle, car cela signifie que vous serez en mesure de les mettre en œuvre sans avoir à suivre des tonnes d’instructions.

Trouver une version à jour des normes de codage (et s’assurer que vous les respectez)

Avant de terminer, j’aimerai vous faire connaître GitHub – en particulier la page des normes de codage WordPress. C’est similaire aux standards de WordPress, mais il y a quelques ajouts représentant des changements plus courants, qui ne sont pas décrits sur le site officiel.

A mon avis, cela fait de la version GitHub le standard de codage officiel de facto. La version 1.0 est sortie en juillet 2018, et a une différence clé – c’est essentiellement une collection de règles PHP_CodeSniffer (ou ‘sniffs’). Si vous n’êtes pas familier avec cet outil, il prend en charge votre PHP, CSS et JavaScript, et détecte toute différence ou violation entre votre code et les standards.

Si vous suivez les normes de contribution de base (comme vous devriez le faire), il est pratiquement essentiel de tirer profit de ces sniffs. Nous vous recommandons de lire la documentation GitHub et de choisir votre méthode d’installation préférée. Ensuite, vous pouvez tirer parti de certains des sniffs supplémentaires disponibles, tels que ceux pour la documentation en ligne, et vous aurez accès à certaines des meilleures pratiques non incluses dans les normes de base.

Conclusion

Nous pouvons utiliser un vieux paradigme de programmeur pour décrire comment vous devriez aborder chaque aspect de votre codage : “Poubelle à l’intérieur, poubelle à l’extérieur.” En fin de compte, si la qualité de votre code n’est pas à la hauteur, vous vous rendez un mauvais service à vous-même et à vos utilisateurs.

Heureusement, WordPress dispose d’un ensemble documenté de normes que tout développeur peut suivre pour s’assurer que son code mérite d’être inclus. En suivant ces normes, vous garantissez que les équipes d’examen spécialisées approuveront vos engagements. Cela vous donne une longueur d’avance pour commencer votre prochain projet.

Avez-vous des questions sur la façon d’utiliser les normes de codage WordPress ? Faites-le moi savoir dans la section commentaires ci-dessous ! En attendant et si vous êtes curieux vous pouvez continuer votre lecture sur les metas query dans WordPress


siddhy

Développeur web full stack depuis une 15aine d'année dans une agence web du sud de la France et Geek depuis toujours, l'apprentissage et le partage font parti intégrante de ma philosophie au même titre que l'évolution personnelle et la sagesse bouddhiste.

0 commentaire

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *