Les normes de codage WordPress tout rassembler

Lorsqu'il s'agit d'écrire une série de billets de blog, l'un des aspects les plus difficiles en tant que lecteur est de suivre chaque message publié..

Même si vous parvenez à suivre le rythme, les messages dépassant 1 000 mots, en particulier ceux qui incluent du code, peuvent prendre du temps que beaucoup d’entre nous n’ont pas, surtout quand il s’agit de jongler avec nos vies professionnelle, personnelle et familiale passe-temps et autres.

Donc, afin de m'assurer que les informations présentées tout au long de cette série sont toujours présentées de manière compréhensible, j'ai pensé essayer de résumer l'ensemble de la série. De cette façon, ceux qui ont manqué un article ou qui n’ont pas eu le temps de s’asseoir et qui ont lu chaque article peuvent quand même comprendre l’essentiel de chaque point mentionné dans les articles..

Cela dit, examinons tout ce que nous avons couvert lors de la révision des normes de codage WordPress..

Les normes de codage WordPress

De manière générale, le but de toute cette série est de contribuer à éclaircir les normes de codage WordPress afin que ceux qui n'en ont pas entendu parler, ceux qui ne les connaissent pas ou ceux qui ne les ont pas suivies soient mieux équipés pour écrire Thèmes, plugins et applications WordPress.

Pour ce faire, nous avons analysé en profondeur différents aspects des normes de codage dans six articles différents qui mettent en évidence les principes, les meilleures pratiques et les mesures à éviter..

Ci-dessous, nous avons résumé chacun des articles ainsi que les points centraux qui méritent d’être mentionnés pour le sujet en question. Bien sûr, si vous souhaitez plus d'informations, vous pouvez revenir à l'article de la série (lié en haut de cet article) pour le lire en entier..

1. Conventions de dénomination et arguments de fonction

Conventions de nommage

Lorsque vous travaillez avec des classes, des fonctions, des variables, des attributs ou des arguments, les conventions de dénomination devraient aider à expliquer le but qu'elles servent..

Par exemple, les classes sont généralement des noms et les noms de fonctions sont normalement des verbes. En fin de compte, il s'agit de s'assurer que le code est lisible et maintenable.

Directement des normes de codage:

Ne pas abréger les noms de variables de manière non nécessaire. laisser le code sans ambiguïté et auto-documenté.

Mais ce principe particulier mérite d'être suivi indépendamment où vous travaillez dans le code.

Arguments de fonction

Rappelez-vous que lorsqu'il s'agit de passer des arguments de fonction, il est important de se rappeler que si un nom de fonction décrit l'action qu'il effectue dans le contexte de la classe, alors l'argument doit représenter le fonctionnement réel de la fonction..

Préférez les valeurs de chaîne à juste vrai et faux en appelant des fonctions.

Cela signifie que les arguments de la fonction doivent être des valeurs claires - chaînes ou nombres -, car les valeurs booléennes sont souvent peu claires et n'indiquent pas nécessairement quelle action la fonction effectuera..

2. L'utilisation de devis simples et doubles

Quand il s’agit de travailler avec des chaînes dans WordPress, il s’agit généralement de s’intégrer aux nuances de la manipulation des chaînes PHP. En tant que tel, dans cet article, nous avons examiné comment PHP traite les guillemets (simples et doubles) et comment cela affecte notre développement WordPress..

Guillemets simples

Le moyen le plus simple de définir une chaîne en PHP consiste à l'envelopper de guillemets simples (c'est-à-dire du caractère ')..

Comme avec la plupart des langages de programmation, il sont façons d'échapper aux caractères afin que vous puissiez écrire un littéral de chaîne. Par exemple, si vous voulez écrire: "Les chaînes en PHP sont faciles", sous forme de chaîne, vous pouvez procéder comme suit:

"Les chaînes en PHP sont faciles."

Les barres obliques inverses demanderont à PHP d'écrire le guillemet simple plutôt que de terminer la chaîne. La deuxième chose à noter est que si vous avez une variable, il sera ne pas remplacé lorsque cité entre guillemets.

Double citation

Les guillemets doubles fonctionnent un peu différemment dans PHP. Plus précisément:

Si la chaîne est placée entre guillemets ("), PHP interprétera davantage de séquences d'échappement pour les caractères spéciaux..

Cela signifie que si vous incorporez une variable dans une chaîne PHP à double guillemet, alors la variable sera interprétée et sa valeur sera insérée à la place de la variable avant de l'afficher à l'écran..

Cordes et WordPress

Comme une grande partie du travail effectué dans WordPress inclut également la rédaction de balises dans une chaîne PHP, il est préférable de placer ces chaînes entre guillemets simples afin que les attributs de l'élément HTML puissent être placés entre guillemets.

Mais il est parfois préférable d'utiliser des guillemets doubles notamment quand vous avez besoin d'évaluer une variable.

Le meilleur conseil que nous puissions offrir ici est de savoir comment fonctionnent les guillemets simples et les guillemets doubles dans PHP, puis de les utiliser de manière appropriée en fonction de votre cas d'utilisation..

3. Indentation, espaces utilisables et espaces de fuite

N'oubliez pas: les espaces blancs améliorent la lisibilité du code et, en tant que développeur, l'un de nos principaux objectifs doit être de nous assurer que le code que nous écrivons ne respecte pas seulement une norme prédéfinie, mais qu'il s'adresse également aux autres développeurs afin de faciliter maintenabilité.

Échancrure

En ce qui concerne l'indentation, il n'y a rien de vraiment nouveau, surtout si vous connaissez les langages de type C. La plupart du temps, vous indenterez chaque fois que vous commencerez un nouveau bloc.

• Vos fonctions seront en retrait dans la classe
• Vos conditionnels et switch / cases et autres blocs seront indentés dans leurs fonctions
• Vos boucles seront indentées dans leurs fonctions, dans leurs conditions, etc.

Notez que les normes de codage faire avoir des règles sur les tabulations et les espaces:

Votre mise en retrait doit toujours refléter la structure logique. Utilisation vrais onglets et pas d'espaces, car cela permet le plus de flexibilité entre les clients.

Ceci est particulièrement utile dans la communauté open source.

Utilisation de l'espace

Les espaces doivent être placés aux endroits suivants:

• Après les virgules
• Des deux côtés des opérateurs logiques (c’est-à-dire, ||, &&, et !)
• Des deux côtés des opérateurs de comparaison (c’est-à-dire, <, >, ==, ===, etc.)
• Des deux côtés des opérateurs d'assignation (à savoir =)
• Sur les deux côtés des parenthèses ouvrantes et fermantes des fonctions, des conditions, des boucles, etc..
• Lorsqu'une variable est passée en tant qu'index d'un tableau, mais ne pas lorsqu'une valeur littérale (telle qu'une chaîne ou un entier)

Espaces de fuite

C'est l'une des conventions les plus simples à suivre. Honnêtement, il y a de fortes chances pour que votre IDE ou l'éditeur de votre choix intègre cette fonctionnalité, ou qu'un plugin soit disponible pour vous permettre de le faire automatiquement..

Sinon, vous devriez pouvoir activer la possibilité de voir les tabulations, les espaces, les retours à la ligne, etc., de manière à pouvoir facilement identifier où les espaces de fuite sont. Et quand vous les voyez, éliminez-les.

4. Style d'accolade, expressions régulières et balises PHP

Dans cette section, nous avons examiné pourquoi le style est important. Nous avons également défini exactement comment les normes et conventions de codage définissent Comment nous appelons notre code.

Style de Brace

De manière générale, les règles sont simples:

• Les blocs d'une seule ligne peuvent omettre des accolades
• Les blocs multilignes doivent toujours inclure des accolades
• Si vous avez trop de conditionnels multilignes, envisagez de les diviser en leurs propres fonctions afin de minimiser le blocage.

Celles-ci sont particulièrement courantes si vous venez d'autres langages de style C; cependant, tout comme WordPress a des nuances subtiles que d’autres langues n’a pas, il convient de les souligner ici.

Expressions régulières

PHP offre une variété de façons de travailler avec des expressions régulières, bien que WordPress recommande de n'utiliser qu'une poignée des fonctions disponibles..

Les règles d'utilisation des expressions régulières en PHP dans WordPress sont les suivantes:

• Utilisez le preg fonctions offertes par PHP
• Ne pas utiliser le \ e commutateur offert par PHP - utilisation preg_replace_callback au lieu.

Plus précisément, je vous recommande de vous familiariser avec les fonctions suivantes:

• preg_replace
• preg_match
• preg_match_all

De plus, notez que preg_replace_callback est un moyen d'appeler une fonction lorsqu'une expression régulière a trouvé une correspondance..

Tags PHP

Il existe une règle très simple d'utilisation des balises PHP dans le développement WordPress:

• Ne jamais utiliser des balises PHP abrégées

Cela signifie que vous ne devriez jamais ouvrir un fichier ou une déclaration PHP en ligne avec  ou avec . Naturellement, toutes les instructions PHP en ligne doivent être terminées avec ?> balise de fermeture.

 $ uses_gasoline = 'hybride' == $ car_type? faux vrai; echo $ uses_gasoline;