Un guide sur la façon d’améliorer les normes de codage WordPress
Si vous êtes un développeur, vous cherchez certainement à améliorer vos normes de codage. Chaque langage de programmation et leur CMS/Frameworks ont mis en place leurs propres normes de codage. Dans cet article, nous étudions comment améliorer les normes de codage WordPress.
Nous avons écrit un article sur l’ amélioration des normes de codage PHP. Vous devez d’abord consulter cet article avant de procéder aux normes de codage pour le développement WordPress.
Erreurs que nous faisons lors de la programmation WordPress
Chaque travail de développement a des solutions différentes. Il est probable que chaque développeur implémente une manière/une logique différente pour donner le même résultat. C’est naturel dans le monde de la programmation.
Par exemple, disons que nous avons ajouté du nonce dans notre formulaire d’inscription pour éviter les attaques CSRF.
<form method="post">
<?php wp_nonce_field( 'signup_nonce', 'signup_form_nonce' ); ?>
</form>Lors de la soumission d’un formulaire, nous devons vérifier si le nonce est correct ou non. Normalement, un développeur qui ne connaît pas les normes de codage le fait de la manière suivante.
<?php
if (! isset( $_POST['signup_form_nonce']) ||! wp_verify_nonce( $_POST['signup_form_nonce'], 'signup_nonce')) {
print 'Sorry, your nonce did not verify.';
exit;
} else {
// process form data
}
?>Il n’y a rien de mal dans le code ci-dessus. Mais, ce n’est pas une bonne pratique. Lors de la récupération des valeurs de champ de texte, nous devons utiliser sanitize_text_field()et des wp_unslash()fonctions sur les valeurs de champ d’entrée.
La méthode sanitize_text_field effectue le processus suivant en arrière-plan.
- Vérifie l’UTF-8 non valide
- Convertit les caractères < simples en entité
- Supprime toutes les balises
- Supprimez les sauts de ligne, les tabulations et les espaces blancs supplémentaires
- Supprimer les octets
La méthode wp_unsplash supprime les barres obliques d’une chaîne ou d’un tableau de chaînes.
Cela dit, notre code précédent devrait aimer ci-dessous.
<?php
if (! isset( $_POST['signup_form_nonce']) ||! wp_verify_nonce( sanitize_text_field( wp_unslash( $_POST['signup_form_nonce']) ), 'signup_nonce')) {
print 'Sorry, your nonce did not verify.';
exit;
} else {
// process form data
}
?>Ceci est un exemple. Il y a plusieurs autres erreurs que nous faisons dans notre programmation WordPress.
Installer la bibliothèque de normes de codage WordPress
Cette bibliothèque nous aidera à améliorer nos normes de codage dans le développement WordPress et à nous établir comme un meilleur développeur WordPress.
Pour installer cette bibliothèque, ouvrez votre invite de commande dans le répertoire racine d’un projet et exécutez la commande ci-dessous.
composer create-project wp-coding-standards/wpcs --no-dev
Remarque : vous devez avoir installé composer sur votre système pour exécuter la commande ci-dessus.
Après avoir exécuté la commande, il créera un dossier appelé ‘wpcs’ dans votre répertoire racine d’un projet.
Nous supposons que vous avez lu notre article sur l’ amélioration des normes de codage PHP et que vous avez installé la bibliothèque PHP_CodeSniffer dans le dossier ‘php_codesniffer’ du répertoire racine du projet.
Ensuite, nous devons enregistrer les normes WordPress dans la configuration PHP_CodeSniffer. Ouvrez l’invite de commande sous ‘php_codesniffer/vendor/bin’ et exécutez la commande ci-dessous.
phpcs --config-set installed_paths /path/to/wpcs
Remplacez ‘/path/to/wpcs’ par votre chemin. Dans notre cas, sur la plate-forme Windows, nous écrivons la commande comme suit.
phpcs --config-set installed_paths D:wampwwwwp1wpcs
Découvrons nos erreurs et améliorons les normes de codage WordPress
Nous avons mis avec notre bibliothèque. Maintenant, il est temps de trouver nos erreurs et de les éviter la prochaine fois.
Disons que nous avons créé un plugin ‘test-plugin’ et que nous devons valider un fichier nommé ‘core.php’.
Ouvrez l’invite de commande sous le répertoire ‘wpcs/vendor/bin’ et exécutez la commande ci-dessous.
phpcs --standard=WordPress D:wampwwwwp1wp-contentpluginstest-plugincore.php
Après avoir exécuté la commande, vous serez invité avec les erreurs et les avertissements. Toutes ces erreurs et avertissements s’affichent parce que nous n’avons pas suivi les pratiques de codage standard pour le développement WordPress.
Une bonne partie est que nous obtenons le rapport détaillé sur les numéros de ligne et comment corriger cette erreur spécifique. Nous avons juste besoin d’examiner les lignes directrices et de corriger les erreurs une par une.
phpcbf La commande peut également corriger certaines erreurs mineures comme l’indentation, les espaces, etc.
phpcbf --standard=WordPress D:wampwwwwp1wp-contentpluginstest-plugincore.php
Nous espérons que vous comprendrez comment utiliser la bibliothèque de normes de codage WordPress pour améliorer les normes de codage WordPress. Si vous avez des questions ou des suggestions, veuillez laisser un commentaire ci-dessous.