Les normes de codage de WordPress garantissent la cohérence et la maintenabilité de la vaste base de code de la plateforme. Ces lignes directrices méticuleusement élaborées distillent des conseils de développement WordPress, favorisant la clarté et l'efficacité.
En suivant ces guides de maintenance WordPress, les développeurs du monde entier contribuent harmonieusement à la compréhension du travail de chacun. Faites en sorte que votre équipe de développement WordPress suive assidûment les normes de codage de WordPress pour garantir des solutions de haute qualité, évolutives et faciles à maintenir sur le long terme.
Pourquoi s'en tenir aux normes de codage de WordPress ?
Les normes de codage de WordPress visent à assurer la cohérence du code entre les projets et les contributeurs. Elles améliorent la lisibilité et la maintenabilité pour le développement collaboratif et facilitent les révisions de code et l'adhésion aux meilleures pratiques dans l'écosystème WordPress.
Quelles sont les normes de codage de WordPress ?
Les normes de codage de WordPress constituent une base de collaboration et de cohérence pour l'ensemble du projet et de la communauté WordPress, du code de base aux thèmes et aux plugins. Ces normes, développées par la communauté WordPress, en consultation avec les équipes de support de WordPress, constituent les meilleures pratiques que les développeurs et les contributeurs de WordPress devraient suivre.
En savoir plus: Comment réduire l'impact du code tiers ?
Importance des normes de codage
Les normes de codage permettent d'éviter les erreurs courantes, d'améliorer la lisibilité du code et de simplifier les modifications. En les respectant, le code apparaît comme s'il avait été écrit par une seule personne, ce qui le rend plus facile à comprendre et à modifier.
Contribution au noyau de WordPress
Si vous contribuez au noyau de WordPress, il est essentiel de vous familiariser avec ces normes, car le code soumis doit s'y conformer.
Vous avez du mal à respecter les normes de codage pour votre site WordPress unique ?
Laissez nos développeurs WordPress experts s'occuper du casse-tête !
Composantes des normes de codage de WordPress
Les normes couvrent les lignes directrices spécifiques aux langages CSS, HTML, JavaScript et PHP, ainsi que les lignes directrices en matière d'accessibilité alignées sur les WCAG AA.
Lire aussi : Comment convertir HTML en thème WordPress ?
Exception pour les bibliothèques de tiers
Toutefois, les bibliothèques tierces intégrées à WordPress sont exemptées de ces normes.
Exemples de normes de codage WordPress
Explorons les normes de codage de WordPress à travers divers exemples afin de comprendre leur application dans des scénarios réels. Ces exemples illustrent les meilleures pratiques recommandées pour écrire un code clair et facile à maintenir dans WordPress.
PHP DANS WORDPRESS
WordPress utilise les mises à jour PHP comme langage de programmation de base. Le respect des normes de codage PHP est essentiel pour assurer la maintenance et la cohérence du code de WordPress. Voici pourquoi les normes de codage PHP sont importantes :
Sauts de ligne
WordPress ne donne pas beaucoup d'indications sur les sauts de ligne, mais il est courant d'en ajouter un après la plupart des déclarations. Il est également recommandé de placer les définitions de variables, les blocs if et les éléments de tableaux sur des lignes séparées.
Indentation
Pour faciliter la lecture de votre code, utilisez l'indentation pour montrer sa structure logique. Les tabulations doivent être utilisées au début des lignes, tandis que les espaces sont utilisés pour l'indentation en milieu de ligne.
Utilisation de l'espace
Facilitez la lecture de votre code en supprimant les espaces supplémentaires en fin de ligne. Éliminez également les lignes vides avec des tabulations ou des espaces insécables. Utilisez des espaces entre les parenthèses pour plus de clarté. Ajoutez un saut de ligne après une accolade ouvrante et avant une accolade fermante, sauf pour la frappe.
Citations
Dans WordPress, la règle principale est d'utiliser des guillemets simples pour les chaînes de caractères, sauf si vous évaluez quelque chose à l'intérieur. Si vous avez besoin de guillemets à l'intérieur d'une chaîne, alternez entre guillemets simples et doubles. L'échappement des guillemets est autorisé mais rarement nécessaire.
Appareils dentaires
La méthode la plus simple consiste à toujours utiliser des accolades. Alors que les normes permettent de ne pas utiliser d'accolades pour les instructions "if" d'une seule ligne sans blocs de plusieurs lignes dans la même structure, cela n'est pas autorisé pour les boucles d'une seule ligne. Je préfère utiliser systématiquement les accolades pour plus de clarté. De plus, les standards spécifient de placer l'accolade d'ouverture sur la même ligne que l'instruction initiale, et non pas en dessous comme dans la documentation PHP.
Formatage des requêtes SQL
Lorsque vous écrivez des requêtes SQL, n'oubliez pas de mettre les mots-clés en majuscules. Les requêtes complexes doivent être scindées en plusieurs lignes. Il est important de bien comprendre les requêtes, en particulier leurs aspects liés à la sécurité, que nous aborderons plus loin. Les attaques par injection SQL sont dues à des erreurs de sécurité de WordPress, qui permettent aux pirates d'accéder directement à la base de données d'un site WordPress et de la manipuler.
Conventions d'appellation
Dans le code WordPress, évitez les noms en CamelCase. Les fonctions doivent utiliser des caractères minuscules, avec des traits de soulignement si nécessaire. Les noms de classes doivent mettre en majuscule la première lettre de chaque mot, séparée par des traits de soulignement.
Les noms de fichiers doivent être entièrement en minuscules, avec des traits d'union entre les parties. Si un fichier contient une seule classe, il doit porter le nom de la classe, précédé de "class-".
Pour plus de clarté, utilisez des chaînes de caractères pour les arguments des fonctions plutôt que des booléens. La règle la plus importante est de rendre les noms descriptifs. Dans un environnement collaboratif, essayez d'aider tout le monde à comprendre votre code.
Déclarations comparatives
Une bonne pratique, pas seulement pour WordPress, est de toujours placer la variable du côté droit d'une comparaison. De cette façon, si vous oubliez un signe égal, cela provoquera une erreur au lieu de s'évaluer à vrai. Si vous aimez utiliser des opérateurs ternaires, c'est autorisé, mais il est recommandé de vérifier la véracité pour rendre les choses plus claires. Une exception est la vérification des variables non vides à l'aide de ! empty().
FORMATAGE HTML
Selon le Codex de WordPress, il est important de valider tout le code HTML à l'aide du validateur W3C. Cependant, un code valide ne signifie pas toujours un bon code, bien qu'il y ait un lien évident entre les deux.
Doctype
WordPress suit la spécification XHTML 1.0 recommandée par le W3C en 2000. Malgré cela, le thème Twenty Eleven, un thème par défaut de WordPress, utilise HTML5. Il n'y a pas de conflit réel car HTML5 inclut la sérialisation XML, ce qui permet d'utiliser "XHTML5".
Utilisation des citations
En HTML, les guillemets sont principalement utilisés pour les attributs et leurs valeurs. Vous pouvez choisir des guillemets simples ou doubles, mais restez fidèle à un type de guillemets. Personnellement, j'utilise les guillemets simples dans la mesure du possible, comme je le fais en PHP, pour des raisons de cohérence. Cela me permet de repérer rapidement les cas particuliers d'une ligne en regardant simplement les guillemets.
Étiquettes de fermeture
La spécification XHTML impose la fermeture de toutes les balises. Les éléments vides doivent être fermés par une barre oblique juste avant le dernier crochet. Veillez à ce qu'il y ait un espace avant la barre oblique, comme spécifié.
Indentation
Indentez votre HTML en suivant les mêmes règles que pour le PHP. Visez une structure logique avec votre indentation. Lorsque vous combinez PHP et HTML, indentez les blocs PHP en suivant les règles d'indentation habituelles.
FORMATAGE CSS
Le formatage CSS consiste à organiser et à styliser la présentation du contenu web, afin de garantir la cohérence et la lisibilité sur différents appareils et navigateurs. Des feuilles de style CSS correctement formatées améliorent la structure et l'attrait visuel des sites web, contribuant ainsi à une meilleure expérience utilisateur.
En savoir plus : Comment supprimer les CSS inutilisés dans WordPress ?
Indentation et structure
Votre feuille de style CSS doit suivre ce schéma approximatif : Écrivez chaque sélecteur sur une ligne distincte, même si vous énumérez plusieurs sélecteurs pour un jeu de règles. De même, chaque paire propriété-valeur doit se trouver sur sa propre ligne. Placez l'accolade d'ouverture sur la ligne du sélecteur et placez l'accolade de fermeture sur une ligne séparée avec la même indentation que celle du sélecteur d'ouverture.
Conventions d'appellation
Utilisez uniquement des caractères minuscules. Séparez les mots d'un sélecteur par un trait d'union. Donnez à vos sélecteurs des noms lisibles par l'homme.
Propriétés et valeurs
Il existe un certain nombre de règles pour l'écriture des propriétés et des valeurs. Utilisez des versions abrégées des propriétés dans la mesure du possible, sauf lorsque vous écrasez une propriété définie précédemment. Utilisez le code HEX minuscule pour les couleurs dans la mesure du possible. Le cas échéant, utilisez la version la plus courte. Insérer un espace après les deux points qui suivent une propriété. Utilisez toujours des caractères minuscules, sauf lorsqu'un caractère majuscule est requis, comme pour les noms de polices et les propriétés spécifiques à un fournisseur. Organisez les propriétés CSS par ordre alphabétique, à l'exception des propriétés spécifiques à un fournisseur, qui doivent toujours précéder leur équivalent général, et des propriétés dimensionnelles, qui doivent être regroupées. Si la largeur et la hauteur sont spécifiées, écrivez d'abord la largeur.
Commentaire
CSS ne prend en charge qu'un seul type de commentaire - le style bloc ; il ne dispose pas d'une notation distincte pour les commentaires en ligne. Rédigez des commentaires courts sur une seule ligne, sans retour à la ligne en dessous. Pour les commentaires qui s'étendent sur plusieurs lignes, insérez un saut de ligne juste après la syntaxe d'ouverture et un saut de ligne juste avant la syntaxe de fermeture. Si vous utilisez des commentaires pour délimiter des sections du code, utilisez la notation suivante :
Utilisation des préprocesseurs CSS
L'utilisation de préprocesseurs CSS tels que SASS et Less nous facilite grandement la vie en tant que développeurs, mais ils ne sont pas sans inconvénients. Le code produit par ces outils est généralement valide, mais on ne peut pas dire qu'il soit très propre. Une feuille de style produite manuellement (et de manière réfléchie) sera beaucoup plus lisible qu'une feuille de style produite automatiquement par Less. Cela dépend de ce que vous faites. Si votre produit est commercial, le but ultime est d'offrir une bonne expérience à l'utilisateur, avec un code valide et optimisé. Dans ce cas, utilisez la sortie du préprocesseur comme CSS principal, mais incluez le fichier original pour les développeurs. Même si votre CSS n'est pas conforme aux normes de WordPress, le fait d'inclure le fichier original permet de combler le fossé jusqu'à ce que WordPress prenne une position officielle. Sacrifier les normes de codage CSS afin de simplifier le processus de développement (dans le but d'améliorer l'expérience de l'utilisateur) est acceptable. Sacrifier la validité du code ne l'est pas.
Comment contribuer aux normes de codage de WordPress ?
Le code, c'est comme l'écriture : chacun a son propre style. Votre HTML peut être différent du mien, mon JavaScript peut vous faire saigner les yeux, et votre CSS peut être d'une beauté qui change la vie. Mais lorsqu'il s'agit de collaborer à un projet comme WordPress, il est essentiel d'avoir des normes de codage cohérentes.
Les normes de codage de WordPress existent pour s'assurer que toute personne contribuant à la base de code peut facilement lire, comprendre et développer le travail des autres. En adhérant à ces normes, vous parlez essentiellement le même langage que les autres contributeurs. C'est comme si vous acceptiez d'utiliser des règles de grammaire et de formatage cohérentes afin que tout le monde puisse collaborer de manière transparente sur le même livre.
Si vous souhaitez contribuer à WordPress, il est essentiel de vous familiariser avec les normes de codage et de les respecter. Cela permet à votre style de codage individuel de s'intégrer parfaitement à la base de code de WordPress.
Conclusions
Le respect des normes de codage de WordPress est essentiel pour maintenir une base de code cohérente et collaborative. Ces directives, élaborées par la communauté WordPress, servent de langage commun aux contributeurs du monde entier. En respectant les normes pour PHP, HTML, CSS, JavaScript et l'accessibilité, les développeurs peuvent s'assurer que leur code est cohérent, lisible et facile à maintenir.
Au fur et à mesure de l'évolution de WordPress, ces normes de codage joueront un rôle crucial dans la promotion d'un environnement de développement harmonieux et efficace pour l'ensemble de la communauté.
