Share
Quelles sont les normes de codage PHP WordPress? Dans cette vidéo de mon cours, Apprendre PHP pour WordPress, vous apprendrez tout sur les normes de codage et leur importance.
Vous pouvez trouver les normes de codage PHP WordPress complètes dans le manuel officiel de WordPress.
Il s’agit essentiellement d’un ensemble de pratiques recommandées sur l’utilisation de PHP dans WordPress. Nous allons passer en revue quelques exemples de ce que cela signifie en pratique dans la suite de ce tutoriel..
Comme vous pouvez le constater, il existe des normes non seulement pour PHP, mais également pour l'accessibilité et pour les autres langages que vous utiliseriez dans WordPress..
Pourquoi est-il important que nous respections tous ces normes??
Eh bien, il y a deux raisons. L'un d'eux concerne la qualité du code et l'autre, la cohérence..
Donc, premièrement, la qualité est importante car cela signifie que tout le monde codant dans WordPress crée un code qui fonctionnera, qui fera son travail et qui sera écrit de manière moderne et de haute qualité..
La seconde, qui concerne la cohérence, est tout aussi importante. Il est très probable que vous travailliez de temps en temps avec le code d'autres personnes. Par exemple, si vous créez un thème enfant, vous devrez peut-être copier une partie du code du thème parent. Et si vous créez un plug-in, ce plug-in peut être une branche d'un plug-in tiers existant que vous copiez et ajoutez des fonctionnalités supplémentaires. Il est vraiment important que votre code soit cohérent avec celui utilisé par tous les autres qui codent PHP pour WordPress..
Voyons donc quelques-unes des normes de codage PHP. Et je vais vous montrer des exemples de ceux-ci dans certains des fichiers de mon thème..
Commençons par les conventions de dénomination et les cas. Lorsque vous envisagez de nommer des conventions, vous devez prendre en compte quatre éléments:
Commençons donc avec les fonctions. Voici le fichier functions.php de mon thème, à titre d'exemple..
Vous pouvez voir que j'ai une fonction que j'ai définie appelée rachelmcc_register_widgets. Tout cela est écrit en minuscules, et j'utilise des traits de soulignement entre les mots, ce qui vous permettra de toujours écrire une fonction dans WordPress..
Comme vous le verrez également, j'ai utilisé un préfixe. Cela garantit que cette fonction ne se heurte à aucune autre fonction fournie par mon thème ou par un autre plugin. Donc, si j'ai écrit une fonction qui vient d'être appelée register_widgets et l'un de mes plugins avait également une fonction appelée register_widgets, les deux pourraient entrer en conflit. Vous pourriez trouver que l’un d’eux remplace l’autre ou que le plugin ne fonctionne pas.
J'utilise donc une fonction unique en rapport avec mon thème. Mon thème s'appelle Rachel Mccollin, donc mes fonctions ont rachelmcc comme préfixe. Et il est également important d'utiliser des traits de soulignement pour vos fonctions et de ne pas utiliser de trait d'union..
Vous faire utilisez des traits d'union à deux endroits. Tout d'abord, vous utilisez des traits d'union lorsque vous définissez des classes CSS. Vous pouvez donc voir que dans mes widgets, je définis des classes CSS pour mon h3 élément et aussi pour la identifiant de cette zone de widget. Et ici, vous utilisez des traits d'union.
L’autre endroit où vous utilisez des tirets se trouve dans vos noms de fichiers. Donc, c'est front-page.php.
Vous devez toujours utiliser des traits d'union dans les noms de fichiers de vos thèmes et de vos plugins. n'utilisez pas de soulignement. Alors, voici un appel utilisant Locate_template. Et loop-frontpage.php est un fichier, une partie de modèle que j'appelle, et vous pouvez voir que c'est un trait d'union et non un trait de soulignement.
D'autre part, mon identifiant de type de message, qui est un type de message personnalisé que j'ai enregistré, utilise un trait de soulignement: rmcc_blurb.
Maintenant, vous devrez peut-être aussi penser aux variables de votre thème. Regardons loop-frontpage.php:
Dans ce fichier particulier, qui est celui que j’appelais de ce fichier précédent, j’ai défini quelques variables, une appelée compter et un appelé Titre. Et vous pouvez voir que j'utilise des minuscules pour les deux.
L'autre endroit où vous devez penser aux traits de soulignement et à la capitalisation est lorsque vous utilisez un cours. Revenons à front-page.php:
Et vous pouvez voir ici, j'utilise le WP_Query classe. Ainsi, une classe a une lettre majuscule après le trait de soulignement, ainsi qu'au début. C'est donc là que vous utilisez la capitalisation pour définir une classe. Cela aide les personnes qui travaillent avec votre code à identifier instantanément qu'il s'agit d'une classe et non d'une fonction..
Voyons maintenant comment utiliser des guillemets simples et doubles en PHP pour WordPress.
Vous pouvez utiliser des guillemets simples ou des guillemets doubles, en fonction de celui qui convient le mieux au code spécifique avec lequel vous travaillez..
Les guillemets peuvent parfois être plus utiles parce qu’ils facilitent le travail avec des caractères spéciaux. Voici un exemple:
Supposons que vous écriviez un fichier de modèle de recherche, search.php. Et à l'intérieur de cela, si rien n'était trouvé, vous mettriez un paragraphe qui dit: "Je suis désolé, votre recherche n'a rien trouvé. Pourquoi n'essayez-vous pas à nouveau?"
J'ai mis cela entre guillemets car le texte contient des apostrophes. Laissez-moi vous montrer comment cela fonctionnerait si nous le faisions entre guillemets.
Vous devez mettre une barre oblique inverse avant les apostrophes pour que celles-ci s'affichent correctement dans le code HTML. Sinon, vous obtiendrez des erreurs. Maintenant, je ne sais pas pour vous, mais je préfère simplement le taper normalement entre guillemets doubles que de faire tout cela entre guillemets simples.
Vous devez également vous rappeler que si vous devez mettre des guillemets entre guillemets, vous devez mettre des guillemets simples entre guillemets doubles ou inversement. Peu importe le sens, mais vous ne pouvez pas mettre de guillemets simples entre guillemets simples ou doubles entre guillemets doubles.
Alors, voici un exemple remontant à mon fichier functions.php.
Ici, j'ai des guillemets simples pour la valeur de before_widget, et puis, à l'intérieur de cela, j'ai des guillemets doubles pour l'ID et la classe de cela. Je ne pouvais pas utiliser de guillemets ici, puis des guillemets, c'est pourquoi j'utilise des guillemets simples, car il est préférable d'utiliser des guillemets avec votre CSS..
Maintenant, regardons l'indentation. Et continuons à regarder le fichier functions.php, qui est un très bon exemple car j'ai mis en retrait un certain nombre de lignes de code à l'intérieur..
Vous pouvez voir que le nom de la fonction est à gauche, puis dans ce qui suit register_sidebar la fonction est en retrait à un niveau. Et le contenu de celui-ci est à nouveau indenté.
Ainsi, chaque fois que vous mettez le contenu entre accolades ou accolades, tout ce qui se trouve à l'intérieur doit être mis en retrait. Et aussi pour l'indentation, vous devriez utiliser des sauts de ligne.
Alors jetons un coup d'oeil à un autre fichier où il y a des lignes simples ainsi que des lignes doubles.
Donc ici vous pouvez voir que j'ai un si déclaration qui a deux lignes de code en son sein. J'ai donc mis un saut de ligne au-dessus et au-dessous de ces deux lignes de code.
S'il n'y avait qu'une ligne de code dans cela, je n'aurais pas à mettre ces espaces entre-je mettrais ça directement dans mes accolades.
L'utilisation d'espacement comme celui-ci permet de déterminer clairement où se trouvent vos blocs de code. Et vous pouvez voir aussi que l'indentation a été utilisée. Donc, il y a plusieurs couches d'indentation.
L'autre chose à garder à l'esprit est l'endroit où vous ouvrez et fermez votre tag PHP et si cela se trouve sur la même ligne que votre code ou sur une autre ligne. Et cela dépend aussi si vous codez un bloc de code ou une seule ligne.
Lorsque vous avez un bloc de code, vous placez votre balise d'ouverture sur une ligne et votre balise de fermeture sur une autre ligne. Cela aide à faire comprendre qu'il s'agit d'un bloc de PHP et que tout ce qui est contenu dans ces balises est PHP..
L'autre chose à faire est d'utiliser une balise PHP à ouverture complète. Donc, n'utilisez pas simplement un point d'interrogation, comme vous l'avez peut-être fait dans d'autres systèmes utilisant PHP, car dans WordPress, vous devez utiliser la balise PHP complète..
Si j'écrivais du PHP sur une seule ligne, je mettrais les balises PHP d'ouverture et de fermeture sur la même ligne.
Vous pouvez voir que nous avons un peu de PHP sur une seule ligne, puis après j'ai du HTML. Donc, les balises d'ouverture et de fermeture vont sur la même ligne que mon code.
Voici une introduction à certains éléments des normes de codage PHP WordPress. Je vous en ai montré quelques exemples dans mes fichiers et en ai modifié quelques-uns au fur et à mesure pour vous montrer comment les choses se passent correctement..
Si vous voulez en savoir plus sur les normes de codage, consultez la documentation sur le site Web WordPress. Et vous pouvez également consulter cette série Envato Tuts +, qui décrit en détail tous les éléments des normes de codage..
Dans le cours complet, Apprenez PHP pour WordPress, vous apprendrez tout sur PHP, le langage de programmation intégré à WordPress..
Je vais vous donner un aperçu de ce que PHP est et comment il est utilisé pour les thèmes et les plugins WordPress, avec des exemples. Vous apprendrez ensuite comment créer un fichier PHP et l’utiliser pour générer du code HTML. Ensuite, vous apprendrez à utiliser des fonctions, des boucles et des instructions if pour coder des thèmes et des plugins WordPress personnalisés..
Vous pouvez suivre ce cours immédiatement avec un abonnement à Envato Elements. Pour un seul forfait mensuel, vous aurez accès non seulement à ce cours, mais également à notre bibliothèque croissante de plus de 1 000 cours vidéo et de livres numériques de premier plan sur l'industrie sur Envato Tuts.+.
De plus, vous obtenez maintenant des téléchargements illimités à partir de la vaste bibliothèque Envato Elements de plus de 580 000 ressources créatives. Créez avec des polices, des photos, des graphiques et des modèles uniques et livrez plus rapidement de meilleurs projets.
Accentsconagua