WordPress garantissent la cohérence et la maintenabilité de l'ensemble du code source de la plateforme. Ces directives, élaborées avec soin, synthétisent les conseils de développement WordPress , favorisant ainsi la clarté et l'efficacité.
En suivant ces de maintenance WordPress , les développeurs du monde entier collaborent harmonieusement et comprennent parfaitement le travail des uns et des autres. Incitez votre de développement WordPress à respecter scrupuleusement les normes de codage WordPress afin de garantir des solutions de haute qualité, évolutives et maintenables sur le long terme.
Pourquoi respecter les normes de codage de WordPress ?
Les normes de codage WordPress visent à garantir 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 revues de code ainsi que le respect des bonnes pratiques au sein de l'écosystème WordPress.
Quelles sont les normes de codage WordPress ?
Les normes de codage WordPress définissent un cadre de collaboration et de cohérence pour l'ensemble du projet et de la communauté WordPress, du code source aux thèmes et extensions. Élaborées par la communauté WordPress en concertation avec les forums d'assistance constituent des bonnes pratiques que les développeurs et contributeurs WordPress sont invités à suivre.
En savoir plus : Comment réduire l’impact du code tiers ?
Importance des normes de codage
Les normes de codage contribuent à prévenir les erreurs courantes, à améliorer la lisibilité du code et à simplifier les modifications. En les respectant, le code apparaît comme s'il avait été écrit par une seule personne, ce qui facilite sa compréhension et sa modification par tous.
Contribution au noyau WordPress
Si vous contribuez au cœur de WordPress, il est crucial de vous familiariser avec ces normes, car le code soumis doit s'y conformer.
Vous avez du mal à maintenir des normes de codage pour votre site WordPress unique ?
Laissez nos développeurs WordPress experts s'occuper de tout !
Composantes des normes de codage WordPress
Ces normes couvrent les directives spécifiques à chaque langage (CSS, HTML, JavaScript et PHP), ainsi que les directives d'accessibilité alignées sur les WCAG AA.
À lire également : 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
Découvrons les normes de codage WordPress à travers divers exemples afin de comprendre leur application concrète. Ces exemples illustrent les bonnes pratiques recommandées pour écrire un code clair et maintenable dans WordPress.
PHP DANS WORDPRESS
WordPress utilise PHP comme langage de programmation principal. Le respect des normes de codage PHP est essentiel pour garantir un code maintenable et cohérent sur WordPress. Voici pourquoi les normes de codage PHP sont importantes :
Sauts de ligne
WordPress ne donne pas beaucoup de précisions sur les sauts de ligne, mais il est courant d'en ajouter un après la plupart des instructions. De même, il est recommandé de placer les définitions de variables, les blocs « if » et les éléments de tableaux sur des lignes distinctes.
Échancrure
Pour faciliter la lecture de votre code, utilisez l'indentation afin d'en indiquer la structure logique. Utilisez des tabulations en début de ligne et des espaces pour l'indentation en milieu de ligne.
Utilisation de l'espace
Améliorez la lisibilité de votre code en supprimant les espaces superflus en fin de ligne. Éliminez également les lignes vides contenant des tabulations ou des espaces insécables. Utilisez des espaces à l'intérieur des parenthèses pour plus de clarté. Insérez un saut de ligne après une accolade ouvrante et avant une accolade fermante, sauf pour les conversions de type.
Citations
Dans WordPress, la règle principale est d'utiliser des guillemets simples pour les chaînes de caractères, sauf lors de l'évaluation d'une expression à l'intérieur d'une chaîne. 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.
Croisillons
La méthode la plus simple consiste à toujours utiliser des accolades. Bien que les normes autorisent leur omission 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 utiliser systématiquement des accolades par souci de clarté. De plus, les normes précisent que l'accolade ouvrante doit figurer sur la même ligne que l'instruction initiale, et non en dessous comme dans la documentation PHP.
Mise en forme des requêtes SQL
Lors de la rédaction de requêtes SQL, n'oubliez pas de mettre en majuscules les mots-clés. Les requêtes complexes doivent être réparties sur plusieurs lignes. Il est important de bien comprendre les requêtes, notamment leurs aspects de sécurité, que nous aborderons plus loin. Les attaques par injection SQL sont dues à des failles de sécurité dans WordPress , permettant ainsi aux pirates d'accéder directement à la base de données d'un site WordPress et de la manipuler.
Conventions de dénomination
Dans le code WordPress, évitez la notation CamelCase pour les noms. Les fonctions doivent utiliser des minuscules, avec des tirets bas si nécessaire. Les noms de classes doivent commencer par une majuscule, les mots étant séparés par des tirets bas.
Les noms de fichiers doivent être en minuscules, avec des tirets entre les éléments. Si un fichier contient une seule classe, nommez-le d'après cette classe, précédée de « class- ».
Pour plus de clarté, utilisez des chaînes de caractères plutôt que des booléens pour les arguments des fonctions. La règle la plus importante est de choisir des noms descriptifs. Dans un contexte collaboratif, veillez à ce que votre code soit compréhensible par tous.
Énoncés comparatifs
Une bonne pratique, valable pour tous, est de toujours placer la variable à droite d'une comparaison. Ainsi, si vous oubliez le signe égal, une erreur sera levée au lieu d'être interprétée comme vraie. L'utilisation d'opérateurs ternaires est autorisée, mais il est recommandé de vérifier systématiquement la valeur pour plus de clarté. Une exception est faite lors de la vérification de variables non vides avec `!empty()`.
MISE EN FORME HTML
D'après le Codex WordPress, il est important de valider tout le code HTML à l'aide du validateur W3C. Cependant, un code valide n'est pas toujours synonyme de bon code, même s'il existe un lien évident 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, utilisé par défaut dans WordPress, emploie HTML5. Il n'y a pas de véritable conflit car HTML5 inclut la sérialisation XML, permettant ainsi l'utilisation de « XHTML5 »
Utilisation des guillemets
En HTML, les guillemets servent principalement à encadrer les attributs et leurs valeurs. Vous pouvez utiliser des guillemets simples ou doubles, mais il est préférable d'utiliser systématiquement le même type. Personnellement, j'utilise les guillemets simples autant que possible, comme en PHP, par souci de cohérence. Cela me permet de repérer rapidement les cas particuliers sur une ligne, simplement en regardant les guillemets.
Balises de fermeture
La spécification XHTML exige la fermeture de toutes les balises. Les éléments vides doivent être fermés par une barre oblique juste avant la dernière accolade. Veillez à insérer un espace avant la barre oblique, comme spécifié.
Échancrure
Appliquez les mêmes règles d'indentation au code HTML qu'au PHP. Veillez à une structure logique. Lors de la combinaison de PHP et de HTML, indentez les blocs PHP selon le sens d'indentation habituel.
MISE EN FORME CSS
La mise en forme CSS consiste à organiser et à styliser la présentation du contenu web, garantissant ainsi une cohérence et une lisibilité optimales sur différents appareils et navigateurs. Une mise en forme CSS correcte améliore la structure et l'attrait visuel des sites web, contribuant à une meilleure expérience utilisateur.
Lire la suite : Comment supprimer les fichiers CSS inutilisés dans WordPress ?
Indentation et structure
Votre CSS doit suivre ce schéma général : écrivez chaque sélecteur sur une ligne distincte, même si vous listez plusieurs sélecteurs pour un ensemble de règles. De même, chaque paire propriété-valeur doit figurer sur sa propre ligne. Placez l’accolade ouvrante sur la ligne du sélecteur et l’accolade fermante sur une ligne distincte, avec la même indentation que celle du sélecteur ouvrant.
Conventions de dénomination
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 un humain.
Propriétés et valeurs
Il existe plusieurs règles pour écrire les propriétés et leurs valeurs. Utilisez autant que possible les versions abrégées des propriétés, sauf lorsque vous écrasez une propriété déjà définie. Utilisez le code HEX en minuscules pour les couleurs autant que possible. Si cela est pertinent, utilisez la version la plus courte. Insérez un espace après les deux-points qui suivent une propriété. Utilisez toujours des minuscules, sauf lorsqu'une majuscule est requise, par exemple pour les noms de polices et les propriétés spécifiques à un fournisseur. Classez 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érique, et des propriétés dimensionnelles, qui doivent être regroupées. Si la largeur et la hauteur sont spécifiées, indiquez la largeur en premier.
Commentaire
CSS ne prend en charge qu'un seul type de commentaire : les commentaires de bloc. Il n'existe pas de notation spécifique pour les commentaires en ligne. Rédigez les commentaires courts sur une seule ligne, sans saut de ligne. Pour les commentaires s'étendant sur plusieurs lignes, insérez un saut de ligne juste après la syntaxe d'ouverture et juste avant la syntaxe de fermeture. Si vous utilisez des commentaires pour délimiter des sections de code, utilisez la notation suivante :
Utilisation des préprocesseurs CSS
L'utilisation de préprocesseurs CSS comme SASS et Less simplifie grandement le travail des développeurs, mais présente aussi des inconvénients. Le code généré par ces outils est généralement valide, mais manque souvent de clarté. Une feuille de style créée manuellement (et avec soin) sera bien plus lisible qu'une feuille générée automatiquement par Less. Tout dépend de votre projet. Si votre produit est commercial, l'objectif principal est d'offrir une expérience utilisateur optimale, avec un code valide et optimisé. Dans ce cas, utilisez le résultat du préprocesseur comme CSS principal, mais mettez le fichier original à disposition des développeurs. Même si votre CSS ne respecte pas les standards de WordPress, inclure le fichier original permet de pallier en attendant une position officielle de WordPress. Il est acceptable de faire des compromis sur les standards de codage CSS afin de simplifier le développement (dans le but d'améliorer l'expérience utilisateur). En revanche, sacrifier la validité du code est inacceptable.
Comment pouvez-vous contribuer aux normes de codage WordPress ?
Coder, c'est comme écrire : chacun a son propre style. Votre HTML sera peut-être différent du mien, mon JavaScript pourrait vous donner mal aux yeux, et votre CSS pourrait être d'une beauté époustouflante. Mais lorsqu'il s'agit de collaborer sur un projet comme WordPress, il est essentiel d'avoir des normes de codage cohérentes.
Les normes de codage WordPress visent à garantir que toute personne contribuant au code source puisse facilement lire, comprendre et s'appuyer sur le travail des autres. En respectant ces normes, vous parlez en quelque sorte le même langage que les autres contributeurs. C'est comme s'engager à utiliser des règles de grammaire et de mise en forme cohérentes afin que chacun puisse collaborer harmonieusement à un même ouvrage.
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 personnel de s'intégrer parfaitement à la base de code globale de WordPress.
Conclusions
Le respect des normes de codage WordPress est essentiel pour maintenir une base de code cohérente et collaborative. Ces directives, élaborées par la communauté WordPress, constituent un langage commun pour les contributeurs du monde entier. En suivant les normes relatives à PHP, HTML, CSS, JavaScript et à l'accessibilité, les développeurs peuvent garantir un code 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é.
