WordPress, comme tous les framework de développement dispose de ses propres règles à suivre pour que chacun des développeurs puissent lire et comprendre facilement le code d’un confrère.
C’est ce qu’on appelle les « Codings Standards » soit en français les standards de codage. Pour WordPress, nous avons les WordPress Codings Standards plus connu sous le joli nom de WPCS!
Ces règles de développement sont lisible ici: Découvrir les WordPress Codings Standards
OK, on a ouate mille page de docs… mais je vais pas lire toutes ces docs tout en développant… t’as pas plus simple?
Et ben vous avez de la chance puisque nous pouvons intégrer ces règles directement dans nos IDE ou éditeurs de texte! Ainsi votre code sera vérifié automatiquement lors de vos développement.
J’utilise quotidiennement PHPStorm de Jetbrains mais sachez que ces règles sont utilisable sur quasiment tous les éditeurs de codes.
Ou trouver les WPCS?
Les WPCS sont disponible sur Github. Je vais vous détailler comment moi je fais, mais vous pouvez lire en anglais qu’il y a plusieurs méthodes. Faites votre choix!
La méthode de Séb pour installer les WPCS
Alors ce n’est pas à proprement dit ma méthode… dans le sens ce n’est pas moi qui l’est mis au point… mais c’est celle que j’utilise et que je vais détailler!
Avant d’installer les WPCS, il faut un installer les PHPCS… et oui, WordPress est développé en PHP et pour faire simple, WPCS rajoute des règles ou modifie un peu les règles des PHP Codings Standards.
Retenez que, comme dans tous l’écosystème WordPress, le but est de rendre accessible et faciliter l’accès au développement.
Installer les PHPCS
Personnellement, j’ai une partition sur mon Ubuntu Linux dédiée à mes projets et a coté des projets, j’ai un dossier avec les WPCS et un avec les PHPCS
Les PHPCS sont également disponible sur Github
Cloner le dépôt Github des PHPCS
Rendez vous a l’endroit où vous voulez télécharger les règles puis:
ou
Si vous n’avez pas renseigné de clé SSH sur votre compte GitHub.
Vous devriez normalement avoir maintenant un dossier nommé phpcs.
Cloner le dépôt Github des WPCS
On va réaliser quasiment la meme commande pour cloner le dépot des WPCS cette fois ci:
ou
Je vous rassure, le plus dur est fait…
Paramétrer PHPStorm
Rendez vous dans « File | Settings | Languages & Frameworks | PHP | Quality Tools »
En cliquant sur les 3 point à droite de Configuration vous pourrez spécifier le chemin vers les PHPCS. Il faudra naviguer et sélectionner le fichier « phpcs » présent dans le répertoire « phpcs/bin » obtenu grace au clonage précédant.
Si tout est OK, en bas de la fenêtre affichera la version de Code Sniffer installée.
Passons à WPCS, car après tout… ce sont pour eux qu’on en est là !
Le chemin vers les réglages est File | Settings | Editor | Inspections
le but ici est d’arriver au menu « PHP Code Sniffer Validation » afin de cocher « Installed Standard Paths » et de chercher après avoir cliqué sur le dossier à droite le répertoire récédement cloner avec les WPCS.
Si tout se passe bien…en cliquant sur les 2 flèches circulaires, vous devriez avoir le choix de plusieurs WPCS… personnellement, je choisis WordPress-Extra. puis on valide en cliquant sur OK…
Très cool, merci beaucoup pour les directions! Salut de l’Australie!