Formation PUB020 : WordPress, 2020 Programmation WordPress

15.5 Les bonnes pratiques


Pour personnaliser votre site WordPress, vous pouvez ajouter du code à différents endroits :

  • dans le fichier functions.php de votre thème enfant
  • dans un fichier modèle de votre thème enfant
  • dans une extension que vous coderez entièrement
  • etc.

Peu importe où vous ajoutez ou modifiez du code, vous devez en tout temps respecter les bonnes pratiques WordPress.

Les sections qui suivent vous exposent les grandes lignes à suivre.

▼Publicité Le texte se poursuit plus bas

Noyau WordPress

Rappelez-vous qu'il ne faut jamais modifier les fichiers du noyau Wordpress :

  • Fichiers à la racine du site Web (à l'exception de wp-config.php qui contiendra vos configurations)
  • Fichiers dans le dossier wp-admin
  • Fichiers dans le dossier wp-includes

Si vous modifiez un fichier du noyau WordPress, vos modifications seront perdues dès que vous mettrez WordPress à jour. Et comme l'utilisation d'une version non à jour vous expose à des failles de sécurité, vous devrez tôt ou tard effectuer les mises à jour, et donc écraser vos modifications.

Normes de programmation

Tout développeur WordPress devrait commencer par prendre connaissance des normes de programmation WordPress. Ces normes sont clairement documentées.

Il existe également des normes de documentation du code.

Avant de poursuivre, prenez le temps de lire les documents suivants :

Ajoutez la page des normes de programmation dans vos favoris... vous y référerez souvent pendant le développement de votre site WordPress.

Autres bonnes pratiques

Lors du développement d'un thème ou d'une extension WordPress, il faut être au fait des bonnes pratiques pour tirer profit de tous les avantages WordPress.

Se conformer aux bonnes pratiques permettra également d'être accepté dans la communauté WordPress.

Voici quelques bonnes pratiques à mettre en application, en plus de celles mentionnées plus haut :

  • Toujours se placer en mode débogage pendant le développement. Enlever le mode débogage seulement lorsque le développement et les tests sont complétés.
  • Si vous développez une extension, son code devrait être placé dans une classe afin d'éviter les conflits de noms de variables ou de fonctions.
  • Si vous développez un thème ou si vous écrivez du code dans le fichier functions.php de votre thème enfant, le nom de chaque fonction doit débuter par un préfixe afin d'assurer qu'il soit unique ( ex : function monprefixe_ma_fonction() ).
  • Rendez votre travail prêt pour la traduction en utilisant les fonctions __() et _e().
  • Si vous développez une extension, documentez le mode d'emploi de l'extension dans un fichier README.TXT.
  • Assurez-vous que votre code contienne de nombreux commentaires. À titre indicatif, environ 1 ligne sur 10 devrait contenir un commentaire.
  • Ne codez jamais en dur le nom du dossier ou l'URL du thème ou de l'extension. Utilisez plutôt une des fonctions suivantes :
    • plugin_dir_path() pour le dossier d'une extension. Attention : c'est le chemin du dossier sur le serveur. Ce n'est pas un URL.
    • get_template_directory() pour le dossier du thème ou, si vous utilisez un thème enfant, pour retrouver le dossier de son thème parent. Ici encore, ce n'est pas un URL.
    • get_stylesheet_directory() pour le dossier du thème et ce, même s'il s'agit d'un thème enfant.On obtiendra un chemin et non un URL.
    • plugins_url() pour retrouver l'URL du dossier des extensions
    • get_template_directory_uri() pour l'URL du thème ou, si vous utilisez un thème enfant, pour retrouver l'URL de son thème parent.
    • get_stylesheet_directory_uri() pour l'URL du thème et ce, même s'il s'agit d'un thème enfant.
  • Pour accéder aux données, utilisez toujours l'objet $wpdb.
  • Dans la mesure du possible, utilisez les « hooks » pour ajuster du code existant.
  • Lorsque vous écrivez un extrait de code inspiré de code trouvé sur le Web, indiquez dans un commentaire l'URL du site source.

 

Veuillez noter que le contenu de cette fiche vous est partagé à titre gracieux, au meilleur de mes connaissances et sans aucune garantie.
Par Christiane Lagacé
Dernière révision le 13 septembre 2021
Merci de partager !

Site fièrement hébergé chez A2 Hosting.

Soumettre