Wordpress

Examiner de plus près les normes de codage WordPress

Selon W3tech, 65.1% des sites Web qui utilisent un système de gestion de contenu fonctionnent sur WordPress. C'est un CMS open source renommé écrit en langage PHP. En raison de sa gamme diversifiée de thèmes et de plugins personnalisés, de nombreux fournisseurs SaaS et agences de marketing numérique utilisent WordPress pour créer des sites Web.

Pourquoi WordPress a introduit des normes de codage ?

Étant donné que WordPress est un logiciel open source massif, il se compose d'un énorme code source à exécuter. Cela est dû à la contribution de plusieurs développeurs à cette date. Comme le codage peut être effectué dans plusieurs styles, les développeurs peuvent ajouter n'importe quel type de code avec lequel ils sont familiers à la plate-forme WordPress. Cela peut entraîner des complications pour WordPress.

Si plusieurs styles de codage étaient implémentés dans le code source de WordPress, il deviendrait complexe pour différents développeurs de logiciels de lire et d'étendre les applications du logiciel. Le personnel de DevOps parcourant différents styles de code aurait du mal à identifier les erreurs. Cela peut provoquer le plantage des sites Web au moment du lancement, causant des dommages en termes de perte de clients pour les entreprises.

Pour éviter de telles circonstances, WordPress a introduit des normes de codage. Il s'agissait d'un ensemble de réglementations que les développeurs doivent obligatoirement suivre lorsqu'ils étendent les fonctionnalités de WordPress.

Les normes de codage simplifient le processus de traitement et d'évaluation des volumes d'échantillons de code. En effet, ils suivent les mêmes styles de formatage, ce qui permet aux différents développeurs de comprendre plus facilement ce qui se passe dans le code source. Dans l'ensemble, les normes de codage aident à maintenir la qualité des codes sources fournis par d'autres développeurs.

Quelles normes de codage WordPress utilise-t-il ?

WordPress ne dépend pas uniquement du langage PHP. Il utilise également HTML, CSS et JavaScript. Ainsi, ses normes de codage varient en fonction de ces langages de programmation. Si vous avez hâte de créer votre propre plugin WordPress et d'améliorer la plate-forme WordPress, voici les normes de codage que vous devez suivre lors de la création de votre code.

1. Coder avec PHP

Pour la contribution d'un codage uniforme, propre et compréhensible, WordPress a introduit des normes de codage pour le balisage PHP. Si vous créez des projets WordPress via le balisage PHP, suivez les règles de codage suivantes.

  • Utilisation des devis

WordPress recommande d'utiliser des guillemets doubles et simples dans des conditions appropriées. Les guillemets simples peuvent être utilisés à l'intérieur d'une chaîne lorsque rien n'est évalué. Lorsque vous utilisez des guillemets, réservez un style de citation à utiliser à l'intérieur d'une chaîne et l'autre pour encadrer la chaîne entière.

L'échappement des guillemets dans une chaîne n'est pas encouragé.

  • échancrure

Lors de l'utilisation des indentations, WordPress met l'accent sur l'utilisation des touches de tabulation plutôt que des touches de la barre d'espace pour désigner les lignes de code en retrait. L'avantage de ceci est que votre code devient compatible avec différents éditeurs qui l'utilisent sur différentes plateformes.

L'indentation aide les zones logiques de votre code à se démarquer, les rendant claires et compréhensibles

Si vous utilisez des tableaux associatifs et qu'il contient plusieurs éléments, chaque élément de ce tableau doit avoir sa propre nouvelle ligne. A la fin du dernier élément de votre tableau, ajoutez une virgule. Cela facilite l'ajout de nouveaux éléments dans le tableau ou la modification de son ordre.

  • balises PHP

Lorsque vous utilisez des extraits de code PHP dans des blocs HTML, les balises d'ouverture et de fermeture PHP doivent se trouver sur une ligne distincte.

WordPress interdit l'utilisation de balises PHP abrégées car elles peuvent causer des problèmes lors de l'exécution de votre code.

  • Bretelles

WordPress rend obligatoire l'utilisation d'accolades dans votre code. Une accolade ouvrante doit être placée dans la ligne de l'instruction de début. Les accolades ne sont omises que pour les instructions sur une seule ligne. Les instructions de boucle doivent également inclure des accolades. Si des instructions multi-blocs sont utilisées, les accolades sont nécessaires.

  • Utilisation de l'espace

Un espace doit être placé des deux côtés des opérateurs d'affectation, logique, de comparaison et de chaîne et après les virgules. L'espace doit également être mis après l'ouverture et avant la fermeture des parenthèses, sauf pour les transtypages. Les espaces à la fin de chaque ligne de code doivent être supprimés.

  • Instructions SQL

Les normes de codage de WordPress encouragent l'écriture d'instructions SQL en majuscules. Ces déclarations peuvent être écrites sur une seule ligne tant qu'elles sont courtes et faciles à lire. Pour les requêtes SQL complexes, il est conseillé de les diviser en plusieurs lignes, en indentant chaque instruction SQL.

  • Principes de nommage

Les développeurs sont tenus de suivre les réglementations WordPress tout en nommant les fonctions, les classes et les fichiers pour éviter les erreurs désordonnées. Lors de la création de fonctions ou de variables, les noms doivent être écrits en minuscules, et camelCase est strictement interdit. Si plusieurs mots sont utilisés pour les nommer, séparez-les par un trait de soulignement.

C'est le cas pour les noms de fichiers, sauf que si plusieurs mots sont utilisés, ils doivent être séparés par un tiret. Si votre fichier se compose d'une classe, le nom du fichier doit être écrit au format classe-nom de classe en minuscules avec chaque trait de soulignement remplacé par un tiret.

Si des fichiers constitués de balises de modèle sont lus ou ajoutés dans le dossier wp-includes, -template doit être ajouté à ce nom de fichier.

Lors de la création de classes, les noms de classe doivent être en majuscule. Si plusieurs mots sont utilisés, ils doivent être séparés par un trait de soulignement et chaque mot doit être en majuscule.

2. Codage avec HTML

Les réglementations de codage stipulent que les extraits de code HTML doivent être exécutés via le validateur W3C avant la vérification manuelle du code. Cela permet de repérer et de corriger les erreurs de balisage dans votre code. Les normes suivantes doivent être suivies lors de l'ajout de codage HTML.

  • Balises à fermeture automatique

Les balises à fermeture automatique en HTML doivent être manipulées avec précaution, en particulier avec l'espacement. Le W3C indique que l'espace doit précéder la barre oblique à fermeture automatique lors de l'utilisation de balises à fermeture automatique.

  • Balises et attributs

Les balises aident à concevoir la structure d'une page HTML. Ils entourent le contenu Web et permettent au navigateur de déterminer le type de contenu dont il s'agit. Les attributs fournissent des détails supplémentaires sur les éléments HTML.

Les réglementations de codage de WordPress indiquent que toutes les balises et attributs HTML doivent être écrits en minuscules. Les valeurs d'attribut doivent également être écrites en minuscules pour l'interprétation machine. Dans le cas de rendre les données lisibles par l'homme, une capitalisation appropriée peut être utilisée.

  • Citations

Les guillemets simples ou doubles sont nécessaires lors de l'écriture des valeurs d'attribut en XHTML. Les normes de codage de WordPress pour HTML conseillent le même format pour éviter tout problème de sécurité dans le code HTML.

3. Codage avec CSS

CSS est un autre langage de programmation essentiel pour concevoir la mise en page et le thème de vos pages Web. WordPress a introduit des normes de codage pour le codage CSS afin que les développeurs puissent créer un code cohérent, propre et lisible pour les projets. Voici les directives recommandées.

  • Structure

 CSS offre de nombreuses options pour concevoir votre feuille de style. Cependant, WordPress fournit des directives de base en CSS pour créer un code clair et distinct. Cela aide les autres développeurs à collaborer avec vous pour comprendre le flux de votre document.

La directive conseille d'utiliser des tabulations pour indenter chaque propriété utilisée dans votre code. Les blocs de codage appartenant à la même partie doivent avoir un espace de ligne vierge entre chaque bloc. Pour différencier les pièces de codage, 2 lignes blanches doivent être ajoutées entre chaque pièce de codage.

Si vous répertoriez plusieurs sélecteurs pour un ensemble de règles, chaque sélecteur doit être écrit sur une ligne distincte. Pour les paires propriété-valeur, chacune doit avoir sa propre ligne, utiliser un onglet d'indentation et se terminer par un point-virgule. Lors de l'utilisation d'un seul sélecteur, une accolade ouvrante doit être placée dans la ligne de ce sélecteur.

Sinon, l'accolade ouvrante doit être ajoutée dans la dernière ligne du sélecteur et l'accolade fermante doit être placée dans une ligne distincte au même retrait que le sélecteur ouvrant.

  • Sélecteurs

La norme de codage pour les sélecteurs est similaire aux normes de codage PHP pour les noms de fichiers. Tout en nommant les sélecteurs, ils doivent être écrits en minuscules et des tirets doivent être utilisés pour séparer plusieurs mots. L'utilisation de camelCase et de traits de soulignement est interdite.

Les noms des sélecteurs doivent pouvoir donner une brève description des éléments qu'ils stylisent. Ces noms doivent être lisibles par l'homme. Pour les sélecteurs d'attributs, des guillemets doubles doivent être placés autour de leurs valeurs.

  • Propriétés

WordPress déconseille d'utiliser des propriétés spécifiques qui peuvent réduire la flexibilité de la conception. Sa norme de codage indique que chaque propriété doit être suivie de deux points et d'un espace.

Les propriétés et les valeurs doivent être écrites en minuscules, à l'exception des noms de police. Pour ajouter des couleurs, les codes hexadécimaux ou rgba() sont préférés et les lettres minuscules doivent être utilisées. L'utilisation de propriétés abrégées est conseillée pour les valeurs d'arrière-plan, de bordure, de police, de style de liste, de marge et de remplissage.

4. Codage avec JavaScript

JavaScript est un langage de programmation essentiel pour créer des applications WordPress. WordPress a formulé des règles de codage afin que les développeurs puissent apporter de la cohérence tout en stylisant le code JavaScript. Peu de ces normes de codage sont mentionnées ci-dessous.

  • Refactorisation du code source

En raison des incohérences présentes dans la structure du code de WordPress pour JavaScript, la refactorisation des codes sources était importante pour la maintenir à jour. WordPress résout progressivement ce problème. Il recommande aux développeurs qui travaillent sur du code JavaScript de suivre les directives nécessaires actuelles. Alors que pour les anciens fichiers JavaScript, la refactorisation n'est pas nécessaire.

  • Utilisation de l'espacement

WordPress recommande d'utiliser des espacements de manière appropriée pour améliorer la lisibilité de votre code source, le rendant optimisé pour que les navigateurs le traitent.

Les règlements de codage approuvent cet onglet doit être utilisé pour l'indentation. Les espaces blancs doivent être éliminés sur les lignes blanches et à la fin des lignes. Chaque ligne de code ne doit pas dépasser 80 caractères. Les accolades doivent être utilisées pour les blocs if/for/try et doivent être entrées sur plusieurs lignes.

Conclusion

L'objectif des normes de codage est d'aider les développeurs à former un code lisible. Plus le code est propre, plus il est facile à comprendre et à mettre en œuvre pour les autres. WordPress est une application open source qui est soutenue par les contributions d'une communauté croissante de supporters.

Ainsi, lors de la création de votre projet WordPress, n'oubliez pas de suivre les règles de codage afin de pouvoir contribuer à un codage de qualité.   

Articles Relatifs

0 Commentaires
Commentaires en ligne
Voir tous les commentaires
Retour à bouton en haut