Centralisez vos bouts de code avec « Code Snippets »

On se sert souvent des bouts de code pour ajouter des fonctionnalités à WordPress, ou pour modifier le comportement de fonctionnalités génériques. Les placer dans le fichier functions.php est la norme, mais c'est aussi le meilleur moyen de les perdre lors d'une mise à jour ou d'un changement de thème. Une extension, Code Snippets, permet de les gérer en toute sécurité.

Cet article prend 4 minutes à lire et comporte 835 mots.

Placer vos bouts de code dans le fichier functions.php est deve­nu une norme, et pour­tant, ce n’est pas une bonne pra­tique.

Nous allons voir pour­quoi il ne faut pas se ser­vir de ce fichier pour vos bouts de code, et sur­tout, quelle solu­tion mettre en œuvre.

Le fichier functions.php, les extensions et Code Snippets

À quoi sert exac­te­ment le fichier functions.php ? À modi­fier le com­por­te­ment du thème. Il peut être com­pa­ré à une exten­sion dédiée au thème.

Tout ce qui concerne le thème, et uni­que­ment le thème, peut être ajou­té dans ce fichier. Mais si c’est le com­por­te­ment de WordPress, indé­pen­dam­ment du thème, que vous vou­lez modi­fier, il faut uti­li­ser une extension.

C’est d’ailleurs ce que dit le Codex dans un article (en anglais) concer­nant le déve­lop­pe­ment de thèmes :

Vous pou­vez consta­ter que la même fonc­tion doit être dis­po­nible pour plus d’un thème parent. Si tel est le cas, la fonc­tion doit être créée dans une exten­sion plu­tôt que dans le fichier functions.php du thème. Cela peut inclure des balises de modèle et d’autres fonc­tions spé­ci­fiques. Les fonc­tions conte­nues dans les exten­sions seront vues par tous les thèmes.

Codex WordPress

Pour autant, vous n’au­rez pro­ba­ble­ment pas envie de créer une exten­sion pour chaque bout de code. Autant les cen­tra­li­ser, pour pou­voir les retrou­ver faci­le­ment au besoin.

Première solu­tion…

Développer sa propre extension

Créer une exten­sion n’est pas com­pli­qué. Un simple fichier PHP peut suf­fire, à condi­tion de res­pec­ter cer­taines règles simples.

Mais cette solu­tion implique quand même quelques connais­sances de base en pro­gram­ma­tion et n’est pas à la por­tée de tous les blogueurs.

Il existe bien heu­reu­se­ment une solu­tion alter­na­tive, bien plus simple à mettre en œuvre…

Utiliser l’extension Code Snippets

Regrouper tous les bouts de code et les gérer comme vos articles ou vos pages… c’est exac­te­ment ce à quoi sert l’ex­ten­sion Code Snippets.

Code Snippets

Auteur(s) : Code Snippets Pro

Version actuelle : 3.6.5.1

Dernière mise à jour : 5 juillet 2024

code-snippets.3.6.5.1.zip

94%Évaluations 900 000+Installations WP 5.0+Nécessaire

Pour l’ins­tal­la­tion et l’ac­ti­va­tion, je vous ren­voie à l’ar­ticle Installer, acti­ver, mettre à jour et sup­pri­mer une exten­sion WordPress.

Une fois l’ex­ten­sion acti­vée, une entrée Snippets est insé­rée dans le menu laté­ral de l’in­ter­face d’ad­mi­nis­tra­tion de WordPress.

Utiliser Code Snippets

Configurer l’extension

L’interface d’ad­mi­nis­tra­tion n’est pas tra­duite en fran­çais, pour autant, vous pou­vez vous ser­vir de l’ex­ten­sion sans tou­cher au moindre réglage.

Mais pour le moment, c’est une boîte vide qui n’at­tend que vos bouts de code pour les mettre en action.

Ajouter un bout de code

Vous pou­vez cli­quer direc­te­ment dans le menu sur Add New, ou dans l’in­ter­face de ges­tion de l’ex­ten­sion, sur Add New ou sur En ajou­ter un →.

Voici à quoi res­semble l’in­ter­face dans laquelle vous allez sai­sir votre bout de code :

Et voi­ci la même inter­face, une fois la sai­sie terminée :

Si vous édi­tez un bout de code pré­cé­dem­ment enre­gis­tré, vous n’au­rez plus deux mais quatre bou­tons : Enregistrer les modi­fi­ca­tions, Enregistrer et [dés]activer, Exporter et Supprimer.

Le périmètre d’action du bout de code

Tous les bouts de code n’ont pas à être exé­cu­tés en per­ma­nence : cer­tains ne sont utiles que dans l’in­ter­face d’ad­mi­nis­tra­tion, d’autres sont néces­saires pour l’af­fi­chage du blog… autant ne pas gas­piller de res­sources inuti­le­ment (dans un sou­ci d’optimisation).

Vous avez vos bouts de code, mais si vous vou­lez réins­tal­ler votre blog dans son inté­gra­li­té ? Inutile de vous tra­cas­ser, Code Snippets a tout pré­vu pour…

Importer et exporter des bouts de code

Partager un bout de code, ou tous vos bouts de code, les trans­fé­rer d’un blog à l’autre si vous chan­gez d’hé­ber­geur ou si vous vou­lez les réuti­li­ser sur un autre blog est un jeu d’enfant.

Chaque bout de code peut être expor­té indi­vi­duel­le­ment ou par lots :

L’importation est tout aus­si simple : il suf­fit d’al­ler dans l’en­trée de menu Snippets > Import, de sélec­tion­ner le fichier XML à impor­ter avant de cli­quer sur Transférer et Importer.

Je vous pro­pose cinq bouts de code dont je me sers régu­liè­re­ment sur mes blogs, à dézip­per et à impor­ter une fois Code Snippets ins­tal­lé et acti­vé (c’est le fichier json de l’ar­chive qu’il faut impor­ter, pas l’ar­chive elle-même).

Ces bouts de code servent à sup­pri­mer les infor­ma­tions concer­nant la ver­sion de WordPress uti­li­sée, à per­mettre l’u­ti­li­sa­tion de l’es­pace insé­cable, à ne pas affi­cher les mes­sages d’er­reur lors de ten­ta­tives de connexion infruc­tueuses, à cal­cu­ler et insé­rer le temps de lec­ture et le nombre de mots d’un article, et à sup­pri­mer l’at­tri­but nofollow des liens dans les commentaires.

Voilà, vous avez (enfin !) une solu­tion simple pour gérer effi­ca­ce­ment vos bouts de code 😉

Et vous, uti­li­sez-vous Code Snippets pour vos bouts de code, ou envi­sa­gez-vous de l’utiliser ?