WordPress garantissent la cohérence et la maintenabilité de la vaste base de code de la plateforme. Ces directives méticuleusement élaborées distillent des conseils de développement WordPress , favorisant la clarté et l'efficacité.
En suivant ces de maintenance WordPress , les développeurs du monde entier contribuent harmonieusement, comprenant le travail de chacun de manière transparente. Demandez à votre de développement WordPress de suivre avec diligence les normes de codage WordPress pour garantir des solutions de haute qualité, évolutives et maintenables à long terme.
Pourquoi s’en tenir aux normes de codage WordPress ?
Les normes de codage WordPress visent à garantir la cohérence du code entre les projets et les contributeurs. Il améliore la lisibilité et la maintenabilité pour le développement collaboratif et facilite la révision du code et le respect des meilleures pratiques dans l'ensemble de l'écosystème WordPress.
Que sont les normes de codage WordPress ?
Les normes de codage WordPress fournissent une base de référence pour la collaboration et la cohérence au sein du projet et de la communauté WordPress, du code principal aux thèmes et plugins. Ces normes, développées par la communauté WordPress, en consultation avec les forums de support WordPress, constituent les meilleures pratiques que les développeurs et contributeurs WordPress doivent suivre.
En savoir plus : Comment réduire l'impact du code tiers ?
Importance des normes de codage
Les normes de codage aident à éviter les erreurs courantes, à améliorer la lisibilité du code et à simplifier les modifications. En y adhérant, le code apparaît comme s’il avait été écrit par une seule personne, ce qui le rend plus facile à comprendre et à modifier par quiconque.
Contribution au noyau WordPress
Si vous contribuez au noyau de WordPress, il est crucial de vous familiariser avec ces normes, car le code soumis doit être conforme.
Vous avez du mal à maintenir les normes de codage pour votre site WordPress unique ?
Laissez nos développeurs WordPress experts s’occuper du mal de tête !
Composants des normes de codage WordPress
Les normes couvrent des directives spécifiques aux langages pour CSS, HTML, JavaScript et PHP, ainsi que des directives d'accessibilité alignées sur les WCAG AA.
Lisez aussi : Comment convertir du HTML en thème WordPress ?
Exception pour les bibliothèques tierces
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 WordPress à travers divers exemples pour comprendre leur application dans des scénarios réels. Ces exemples illustrent les meilleures pratiques recommandées pour écrire du code clair et maintenable dans WordPress.
PHP DANS WORDPRESS
WordPress utilise les mises à jour PHP comme langage de programmation principal. Le respect des normes de codage PHP est crucial pour un code maintenable et cohérent dans WordPress. Voici pourquoi les normes de codage PHP sont importantes :
Sauts de ligne
WordPress ne précise pas grand-chose sur les sauts de ligne, mais il est courant d'en ajouter un après la plupart des instructions. En outre, il est recommandé de placer les définitions de variables, les blocs if et les éléments du tableau sur des lignes distinctes.
Échancrure
Pour rendre votre code plus facile à lire, utilisez l'indentation pour afficher sa structure logique. Les tabulations doivent être utilisées au début des lignes, tandis que les espaces sont utilisés pour l'indentation au milieu de la ligne.
Utilisation de l'espace
Rendez votre code plus facile à lire en supprimant les espaces supplémentaires à la fin des lignes. Éliminez également les lignes vides avec des tabulations ou des espaces insécables. Utilisez des espaces entre parenthèses pour plus de clarté. Ajoutez un saut de ligne après une accolade ouvrante et avant une accolade fermante, sauf pour le transtypage.
Citations
Dans WordPress, la règle principale est d'utiliser des guillemets simples pour les chaînes, sauf si vous évaluez quelque chose à l'intérieur. Si vous avez besoin de guillemets dans une chaîne, alternez entre guillemets simples et doubles. L'échappement des guillemets est autorisé mais rarement nécessaire.
Croisillons
Le moyen le plus simple est de toujours utiliser un appareil dentaire. Bien que les normes autorisent le saut des accolades pour les instructions « if » sur une seule ligne sans blocs multilignes dans la même structure, cela n'est pas autorisé pour les boucles sur une seule ligne. Je préfère toujours utiliser des accolades pour plus de clarté. De plus, les normes spécifient de placer l'accolade ouvrante sur la même ligne que l'instruction initiale, et non en dessous comme dans la documentation PHP.
Formatage des requêtes SQL
Lors de l'écriture de requêtes SQL, n'oubliez pas de mettre les mots-clés en majuscule. Les requêtes complexes doivent être divisées en plusieurs lignes. Il est important de bien comprendre les requêtes, notamment leurs aspects de sécurité, dont nous parlerons plus tard. Les attaques par injection SQL se produisent en raison d' erreurs de sécurité WordPress , permettant aux pirates d'accéder et de manipuler directement la base de données derrière un site WordPress.
Conventions de dénomination
Dans le code WordPress, évitez CamelCase pour les noms. Les fonctions doivent utiliser des caractères minuscules, avec des traits de soulignement si nécessaire. Les noms de classe 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 tous en minuscules, avec des traits d'union entre les parties. Si un fichier contient une seule classe, nommez-le d'après la classe, préfixé par « class- ».
Utilisez des valeurs de chaîne pour les arguments de fonction au lieu de booléens pour plus de clarté. La règle la plus importante est de donner des noms descriptifs. Dans un environnement collaboratif, essayez d’aider tout le monde à comprendre votre code.
Déclarations de comparaison
Une bonne pratique, pas seulement pour WordPress, consiste à 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 plutôt que d’être évalué comme vrai. Si vous aimez utiliser des opérateurs ternaires, c'est autorisé, mais il est recommandé de vérifier la vérité pour que les choses soient plus claires. Une exception est lors de la vérification des variables non vides à l'aide de ! vide().
FORMATAGE HTML
Selon le Codex WordPress, il est important de valider tout le code HTML à l'aide du validateur W3C. Cependant, un code valide ne signifie pas toujours qu'il s'agit d'un bon code, même s'il existe un lien clair entre les deux.
Type de document
WordPress suit la spécification XHTML 1.0 recommandée par le W3C en 2000. Malgré cela, le thème Twenty Eleven, par défaut dans WordPress, utilise HTML5. Il n'y a pas de véritable conflit car HTML5 inclut la sérialisation XML, permettant l'utilisation de « XHTML5 ».
Utiliser des guillemets
En HTML, les guillemets sont principalement utilisés pour les attributs et leurs valeurs. Vous pouvez choisir des guillemets simples ou doubles, mais tenez-vous-en à un seul type de manière cohérente. Personnellement, j'utilise des guillemets simples lorsque cela est possible, comme je le fais en PHP, par souci de cohérence. Cela m'aide à repérer rapidement les cas particuliers dans une ligne simplement en regardant les guillemets.
Balises de fermeture
La spécification XHTML impose la fermeture de toutes les balises. Les éléments vides doivent être fermés avec une barre oblique juste avant le dernier crochet angulaire. Assurez-vous qu'il y a un espace avant la barre oblique, comme spécifié.
Échancrure
Indentez votre HTML en suivant les mêmes règles que pour PHP. Visez une structure logique avec votre indentation. Lorsque vous combinez PHP et HTML, indentez les blocs PHP en fonction du flux d'indentation habituel.
FORMATAGE CSS
Le formatage CSS implique d'organiser et de styliser la présentation du contenu Web, en garantissant la cohérence et la lisibilité sur différents appareils et navigateurs. Un CSS correctement formaté améliore la structure et l'attrait visuel des sites Web, contribuant ainsi à une meilleure expérience utilisateur.
Lire la suite : Comment supprimer les CSS inutilisés dans WordPress ?
Indentation et structure
Votre CSS doit suivre ce schéma approximatif : écrivez chaque sélecteur sur une ligne distincte, même si vous répertoriez plusieurs sélecteurs pour un ensemble de règles. De plus, chaque paire propriété-valeur doit se trouver sur sa propre ligne. Placez l'accolade ouvrante sur la ligne du sélecteur et placez l'accolade fermante sur une ligne distincte avec la même indentation que celle du sélecteur d'ouverture.
Conventions de dénomination
Utilisez uniquement des caractères minuscules. Séparez les mots dans 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 de nombreuses règles pour écrire des propriétés et des valeurs. Utilisez des versions abrégées des propriétés dans la mesure du possible, sauf lors de l'écrasement d'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 plus courte. Insérez un espace après les deux points suivant une propriété. Utilisez toujours des caractères minuscules, sauf lorsqu'un caractère majuscule est requis, comme pour les noms de police et les propriétés spécifiques au fournisseur. Organisez les propriétés CSS par ordre alphabétique, à l'exception des propriétés spécifiques au fournisseur, qui doivent toujours précéder leur homologue générale, 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 commentaires : le style de bloc ; il n'a pas de notation distincte pour les commentaires en ligne. Écrivez de courts commentaires sur une seule ligne, sans saut de ligne ci-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 :
Utiliser des préprocesseurs CSS
L'utilisation de préprocesseurs CSS tels que SASS et Less facilite grandement notre vie de développeur, mais ils ne sont pas sans inconvénients. Le code produit par ces outils est généralement valide mais ne peut pas être considéré comme très propre. Une feuille de style produite manuellement (et de manière réfléchie) sera bien plus lisible qu'une feuille produite automatiquement par Less. Cela dépend de ce que vous faites. Si votre produit est commercial, alors l’objectif ultime est une bonne expérience 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. Bien que votre CSS ne soit pas conforme aux normes de WordPress, l'inclusion du fichier original comble quelque peu 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'une meilleure expérience utilisateur) est acceptable. Sacrifier la validité du code ne l’est pas.
Comment pouvez-vous contribuer aux normes de codage WordPress ?
Le code, c’est comme l’écriture : chacun a son propre style. Votre HTML peut être différent du mien, mon JavaScript pourrait vous faire saigner des yeux et votre CSS pourrait être d'une beauté qui changera votre vie. Mais lorsqu’il s’agit de collaborer sur un projet comme WordPress, il est crucial d’avoir des normes de codage cohérentes.
Les normes de codage WordPress existent pour garantir que toute personne contribuant à la base de code puisse facilement lire, comprendre et s'appuyer sur le travail des autres. En adhérant à ces normes, vous parlez essentiellement le même langage que les autres contributeurs. C'est comme accepter 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 et de suivre les normes de codage. Il permet à votre style de codage individuel de s’intégrer parfaitement à la plus grande base de code WordPress.
Conclusions
Le respect des normes de codage WordPress est essentiel pour maintenir une base de code cohérente et collaborative. Ces directives, développées par la communauté WordPress, servent de langage commun aux contributeurs du monde entier. En suivant les normes PHP, HTML, CSS, JavaScript et d'accessibilité, les développeurs peuvent garantir que leur code est cohérent, lisible et maintenable.
À mesure que WordPress continue d’évoluer, 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é.
