{"id":39139,"date":"2020-05-29T00:16:47","date_gmt":"2020-05-29T07:16:47","guid":{"rendered":"https:\/\/kinsta.com\/?p=72202"},"modified":"2023-08-22T11:56:14","modified_gmt":"2023-08-22T10:56:14","slug":"hooks-wordpress","status":"publish","type":"post","link":"https:\/\/kinsta.com\/fr\/blog\/hooks-wordpress\/","title":{"rendered":"Le Bootcamp des hooks WordPress : Comment utiliser les actions, les filtres et les hooks personnalis\u00e9s"},"content":{"rendered":"

Les hooks WordPress sont l’un des outils les plus importants \u00e0 avoir dans l’arsenal d’un d\u00e9veloppeur WordPress<\/a>. Ils sont la base du d\u00e9veloppement des extensions et des th\u00e8mes WordPress. Vous pouvez utiliser les nombreux hooks int\u00e9gr\u00e9s \u00e0 WordPress pour vous \u00ab\u00a0accrocher\u00a0\u00bb au c\u0153ur de WordPress avec votre code personnalis\u00e9 et faire<\/strong> ou modifier<\/strong> quelque chose.<\/p>\n

Il existe deux types de hooks WordPress : Actions<\/strong> et Filtres<\/strong>. Les hooks sont si courants que m\u00eame le c\u0153ur de WordPress les utilise lui-m\u00eame largement. WordPress inclut \u00e9galement un moyen pour vous de d\u00e9finir vos propres hooks personnalis\u00e9s<\/strong> afin que d’autres d\u00e9veloppeurs puissent s’accrocher \u00e0 votre code.<\/p>\n

Apprendre comment fonctionnent les actions, les filtres et les hooks personnalis\u00e9s est essentiel pour ma\u00eetriser le d\u00e9veloppement de WordPress.<\/p>\n

La premi\u00e8re moiti\u00e9 de cet article couvre les bases des hooks WordPress et explique leur fonctionnement \u00e0 l’aide de multiples exemples. Dans la deuxi\u00e8me moiti\u00e9, vous apprendrez comment les utiliser pour personnaliser WordPress, cr\u00e9er vos propres hooks personnalis\u00e9s et les utiliser pour construire vos propres extensions \u00e9volutives.<\/p>\n

Cela vous semble excitant ? Plongeons dans le vif du sujet !<\/p>\n

<\/div><\/kinsta-auto-toc>\n

Que sont les hooks WordPress ?<\/h2>\n

Une page WordPress<\/a> est assembl\u00e9e par des tonnes de fonctions et d’interrogations de bases de donn\u00e9es. Le c\u0153ur de WordPress, les extensions et le th\u00e8me travaillent ensemble pour produire les \u00e9l\u00e9ments de la page tels que le texte, les images<\/a>, les scripts et les styles. Une fois les \u00e9l\u00e9ments assembl\u00e9s, le navigateur les rassemble et affiche la page.<\/p>\n

Les hooks de WordPress vous permettent de vous connecter \u00e0 ce processus de construction \u00e0 certains moments et d’ex\u00e9cuter votre code personnalis\u00e9. La principale fonction des hooks est de vous permettre de modifier ou d’ajouter des fonctionnalit\u00e9s \u00e0 WordPress sans toucher aux fichiers du c\u0153ur<\/a>.<\/p>\n

\"Les
Les hooks vous aideront \u00e0 \u00e9tendre WordPress avec votre propre code<\/figcaption><\/figure>\n

L’API d\u2019extension WordPress<\/a> alimente la fonctionnalit\u00e9 des hooks WordPress. Vous utilisez les hooks en appelant certaines fonctions de WordPress appel\u00e9es Hook Functions <\/strong>\u00e0 des instances sp\u00e9cifiques pendant l’ex\u00e9cution de WordPress.<\/p>\n

Gr\u00e2ce aux fonctions de hook, vous pouvez regrouper votre code personnalis\u00e9 dans une fonction de rappel<\/strong> et l\u2019enregistrer avec n’importe quel hook. Une fois enregistr\u00e9, ce rappel s’ex\u00e9cutera o\u00f9 que soit le hook, vous permettant d’augmenter ou de remplacer les fonctions par d\u00e9faut de WordPress.<\/p>\n

La position du crochet dans le processus d’ex\u00e9cution du code est un facteur important. Vous en apprendrez davantage sur sa signification dans les sections \u00e0 venir.<\/p>\n\n

Deux types de hooks WordPress : Actions et filtres<\/h3>\n

WordPress comprend deux types de crochets appel\u00e9s Actions<\/strong> et Filtres<\/strong>. Les actions vous permettent de faire quelque chose \u00e0 certains points pr\u00e9d\u00e9finis du temps d’ex\u00e9cution de WordPress, tandis que les filtres vous permettent de modifier toute donn\u00e9e trait\u00e9e par WordPress et de la return<\/strong><\/code>.<\/p>\n

Les actions sont d\u00e9finies dans le code WordPress comme suit :<\/p>\n

do_action( 'action_name', [optional_arguments] );<\/code><\/pre>\n
La cha\u00eene action_name<\/strong><\/code> est le nom de l’action. Vous pouvez sp\u00e9cifier la variable [optional_arguments]<\/strong><\/code> pour passer des arguments suppl\u00e9mentaires \u00e0 la fonction de rappel. Si ce champ n’est pas sp\u00e9cifi\u00e9, alors sa valeur par d\u00e9faut sera vide.<\/p>\n
Exemple :<\/strong> L’action do_action( 'wp_head' )<\/strong><\/code> peut \u00eatre accroch\u00e9e pour ex\u00e9cuter un code personnalis\u00e9 chaque fois que WordPress traite l’en-t\u00eate du site<\/a>. Cette action n’a pas d’autres arguments.<\/p>\n
Les filtres sont d\u00e9finis comme suit dans le code WordPress<\/p>\n
apply_filters( 'filter_name', 'value_to_be_filtered', [optional_arguments] );<\/code><\/pre>\n
La cha\u00eene filter_name<\/strong><\/code> est le nom du filtre, la variable value_to_be_filtered<\/strong><\/code> est la valeur qui doit \u00eatre filtr\u00e9e et retourn\u00e9e, et la variable [optional_arguments]<\/strong><\/code> peut passer des arguments suppl\u00e9mentaires, tout comme pour les actions.<\/p>\n
Exemple :<\/strong> Le filtre apply_filters( 'admin_footer_text' , string $text )<\/strong><\/code> peut \u00eatre accroch\u00e9e pour modifier le texte affich\u00e9 dans le pied de page de l’administration. Depuis WordPress 5.4, sa valeur par d\u00e9faut affichera la phrase Merci de faire de <\/em>WordPress<\/em><\/a> votre outil de cr\u00e9ation<\/em><\/code> dans le pied de page de la zone d’administration.<\/em><\/p>\n
Vous apprendrez plus tard \u00e0 vous accrocher aux actions et aux filtres gr\u00e2ce \u00e0 de nombreux exemples tir\u00e9s du c\u0153ur de WordPress.<\/p>\n
Une fois accroch\u00e9, vous pouvez diriger votre code pour faire<\/strong> ou personnaliser<\/strong> quelque chose sur votre site. Par exemple, vous pouvez utiliser des hooks pour envoyer un e-mail automatis\u00e9<\/a> apr\u00e8s avoir publi\u00e9 un article, ou charger des feuilles de style personnalis\u00e9es<\/a> pour modifier l’apparence de votre site.<\/p>\n
\"Les
Les hooks WordPress vous aident \u00e0 interagir avec votre site web ou \u00e0 le modifier<\/figcaption><\/figure>\n
La fa\u00e7on la plus simple de comprendre les hook est d’imaginer votre site WordPress<\/a> comme la construction d’une maison.<\/p>\n
Les hooks s’apparentent \u00e0 l’utilisation d’une grue pour d\u00e9placer des \u00e9l\u00e9ments de construction d’un c\u00f4t\u00e9 \u00e0 l’autre. Les \u00e9l\u00e9ments transf\u00e9r\u00e9s sont les fonctions de rappel<\/strong> qui comprennent votre code personnalis\u00e9<\/a>. Ces \u00e9l\u00e9ments (ou fonctions) peuvent vous aider \u00e0 construire ou \u00e0 modifier la maison.<\/p>\n
\"Exemple
Exemple de hook dans l’action \u00ab\u00a0wp_head\u00a0\u00bb de WordPress<\/figcaption><\/figure>\n
Les fonctions de rappel (callback) peuvent \u00eatre des fonctions PHP normales, des fonctions WordPress par d\u00e9faut ou des fonctions personnalis\u00e9es d\u00e9finies par vous.<\/p>\n
Nous ne pouvons transporter certains articles que sur des supports sp\u00e9cifiques attach\u00e9s \u00e0 des hooks particuliers. Ainsi, les actions ne peuvent \u00eatre accroch\u00e9es qu’avec des fonctions d’action<\/strong>. De m\u00eame, les filtres ne peuvent \u00eatre accroch\u00e9s qu’avec des fonctions de filtre<\/strong>.<\/p>\n
Alors qu’il est fastidieux de changer les hooks et les supports d’une grue, WordPress le rend super facile en incluant plus de 2 200 types de hooks par d\u00e9faut<\/a>.<\/p>\n
\"WordPress
WordPress 5.1 a plus de 2200 hooks natifs (Source : Adam Brown)<\/figcaption><\/figure>\n
Vous pouvez trouver des hooks r\u00e9partis dans le c\u0153ur de WordPress, vous permettant de taper \u00e0 l’endroit exact o\u00f9 vous voulez vous accrocher et d’ex\u00e9cuter votre code personnalis\u00e9.<\/p>\n\n
Hooks vs Actions vs Filtres<\/h2>\n
Selon le manuel des extensions de WordPress<\/a> :<\/p>\n
\u00ab\u00a0Les hooks sont un moyen pour un morceau de code d’interagir\u00a0\/\u00a0modifier un autre morceau de code… Il existe deux types de hooks : Actions et Filtres.\u00a0\u00bb<\/p><\/blockquote>\n
Il y a une incoh\u00e9rence g\u00e9n\u00e9ralis\u00e9e dans la fa\u00e7on dont les termes Hook<\/strong>, Action<\/strong> et Filtre<\/strong> sont utilis\u00e9s. Quelques tutoriels et guides les confondent avec les fonctions qui leur sont associ\u00e9es. Cette confusion est due en grande partie \u00e0 la nature complexe du fonctionnement des hooks.<\/p>\n
M\u00eame si vous regardez attentivement dans le c\u0153ur de WordPress, vous verrez qu’il n’y a pas beaucoup de diff\u00e9rence entre l’ajout d’actions et de filtres. Voici le code source de la fonction add_action()<\/a> du fichier wp-includes\/plugin.php<\/strong><\/code> :<\/p>\n
function add_action( $tag, $function_to_add, $priority = 10, $accepted_args = 1 ) {\u00a0 \u00a0 \u00a0 \n    return add_filter( $tag, $function_to_add, $priority, $accepted_args );\n}<\/code><\/pre>\n
La fonction add_action()<\/strong><\/code> appelle simplement la fonction add_filter()<\/strong><\/code> et retourne sa valeur. Pourquoi ? Parce qu’elles fonctionnent toutes deux fondamentalement de la m\u00eame mani\u00e8re, \u00e0 une diff\u00e9rence pr\u00e8s.<\/p>\n
La fonction apply_filters()<\/strong><\/code> retourne une valeur qui peut modifier les types de donn\u00e9es existants, tandis que la fonction do_action()<\/strong><\/code> ne renvoie rien (valeur NULL en PHP)<\/a>.<\/p>\n
Si vous \u00eates encore confus, ne vous inqui\u00e9tez pas ! Une fois que vous aurez termin\u00e9 la premi\u00e8re moiti\u00e9 de cet article, tout sera clair. Nous nous en tiendrons \u00e0 la terminologie officielle du Codex WordPress car elle est claire, pr\u00e9cise et universelle.<\/p>\n
Pour l’instant, familiarisez-vous avec la routine du hook pr\u00e9sent\u00e9e ci-dessous.<\/p>\n
\"La
La routine du hook : Hooks, fonctions de hook et fonctions de rappel<\/figcaption><\/figure>\n
Faisons la part des choses entre les actions et les hooks.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n
WordPress Hooks<\/strong><\/td>\n<\/tr>\n
Actions<\/strong><\/td>\nFilters<\/strong><\/td>\n<\/tr>\n
Les actions sont utilis\u00e9es pour ex\u00e9cuter des fonctions personnalis\u00e9es \u00e0 un moment pr\u00e9cis de l’ex\u00e9cution du c\u0153ur de WordPress.<\/td>\nLes filtres sont utilis\u00e9s pour modifier ou personnaliser les donn\u00e9es utilis\u00e9es par d’autres fonctions.<\/td>\n<\/tr>\n
Les actions sont d\u00e9finies\u00a0\/\u00a0cr\u00e9\u00e9es par la fonction do_action( 'action_name' )<\/strong><\/code> dans le code de WordPress.<\/td>\nLes filtres sont d\u00e9finis\u00a0\/\u00a0cr\u00e9\u00e9s par la fonction apply_filters( 'filter_name', 'value_to_be_filtered' )<\/strong><\/code> dans le code de WordPress.<\/td>\n<\/tr>\n
Les actions sont \u00e9galement appel\u00e9es Action hooks<\/strong>.<\/td>\nLes filtres sont \u00e9galement appel\u00e9s Filter hooks<\/strong>.<\/td>\n<\/tr>\n
Les actions ne peuvent \u00eatre connect\u00e9es qu’\u00e0 des fonctions d’action. Par exemple, add_action()<\/strong><\/code>, remove_action()<\/strong><\/code>.<\/td>\nLes filtres ne peuvent \u00eatre accroch\u00e9s qu’avec des fonctions de filtre. Par exemple, add_filter()<\/strong><\/code>, remove_filter()<\/strong><\/code>.<\/td>\n<\/tr>\n
Les fonctions d’action n’ont pas besoin de faire passer d’arguments \u00e0 leurs fonctions de rappel.<\/td>\nLes fonctions de filtre doivent transmettre au moins un argument \u00e0 leurs fonctions de rappel.<\/td>\n<\/tr>\n
Les fonctions d’action peuvent effectuer tout type de t\u00e2che, y compris modifier le comportement du fonctionnement de WordPress.<\/td>\nLes fonctions de filtre n’existent que pour modifier les donn\u00e9es qui leur sont transmises par les filtres.<\/td>\n<\/tr>\n
Les fonctions d’action ne doivent rien return<\/strong><\/code>. Cependant, elles peuvent faire echo<\/strong><\/code> \u00e0 la sortie ou interagir avec la base de donn\u00e9es.<\/td>\nLes fonctions de filtrage doivent return<\/strong><\/code> leurs modifications en sortie. M\u00eame si une fonction de filtre ne change rien, elle doit toujours return<\/strong><\/code> l’entr\u00e9e non modifi\u00e9e.<\/td>\n<\/tr>\n
Les actions peuvent ex\u00e9cuter presque tout, tant que le code est valide.<\/td>\nLes filtres doivent fonctionner de mani\u00e8re isol\u00e9e, afin de ne pas avoir d’effets secondaires involontaires.<\/td>\n<\/tr>\n
R\u00e9sum\u00e9 : <\/strong>une action interrompt le processus normal d’ex\u00e9cution du code pour faire quelque chose avec les informations qu’elle re\u00e7oit, mais ne retourne rien en retour, puis sort.<\/td>\n R\u00e9sum\u00e9 : <\/strong>un filtre modifie l’information qu’il re\u00e7oit, la renvoie \u00e0 la fonction d’appel, et d’autres fonctions peuvent utiliser la valeur qu’il retourne.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Parfois, vous pouvez utiliser une action ou un filtre pour atteindre le m\u00eame objectif. Par exemple, si vous souhaitez modifier le texte d’un article, vous pouvez enregistrer une fonction de rappel avec l’action publish_post<\/a> et modifier le contenu de l\u2019article lors de son enregistrement dans la base de donn\u00e9es<\/a>.<\/p>\n
\/\/ define the callback function to change the text\nfunction change_text_callback() { \n    \/\/ add the code to change text here\n}\n\n\/\/ hook in to the 'publish_post' action with the add_action() function\nadd_action( 'publish_post', 'change_text_callback' );<\/code><\/pre>\n
Vous pouvez \u00e9galement enregistrer une autre fonction de rappel avec le filtre the_content<\/a> pour modifier le contenu de l’article avant qu’il ne soit affich\u00e9 dans le navigateur.<\/p>\n
\/\/ define the callback function to modify the text\nfunction change_text_another_callback( $content ) { \n    \/\/ add the code to change text here and then return it \n    return $filtered_content;\n}\n\n\/\/ hook in to 'the_content' filter with the add_filter() function\nadd_filter( 'the_content', 'change_text_another_callback');<\/code><\/pre>\n
Deux approches diff\u00e9rentes avec le m\u00eame r\u00e9sultat. Savoir quand utiliser l’une plut\u00f4t que l’autre est la cl\u00e9 pour \u00eatre un bon d\u00e9veloppeur WordPress<\/a>.<\/p>\n
Comment fonctionnent les hooks WordPress ?<\/h2>\n
L’exemple de la maison \u00e9tait assez simple pour comprendre le fonctionnement de base des hooks, mais il ne rend pas compte de la complexit\u00e9 de leur fonctionnement. Il s’agit surtout des concepts de position et de sp\u00e9cificit\u00e9 des hooks.<\/p>\n
Un meilleur exemple serait d’imaginer le traitement d’une page web WordPress comme l’assemblage d’une voiture. Contrairement \u00e0 la fabrication d’une voiture, qui prend du temps, l’assemblage d’une page web est presque instantan\u00e9.<\/p>\n
\"Assembler
Assembler une page web, c’est comme assembler une voiture<\/figcaption><\/figure>\n
Tout comme une voiture est assembl\u00e9e pi\u00e8ce par pi\u00e8ce dans une cha\u00eene de montage moderne, une page web WordPress est assembl\u00e9e \u00e9l\u00e9ment par \u00e9l\u00e9ment par le serveur et le client.<\/p>\n
Le c\u0153ur de WordPress est comme le moteur de la voiture, le ch\u00e2ssis et d’autres \u00e9l\u00e9ments essentiels, qui alimentent la fonctionnalit\u00e9 du \u00ab\u00a0c\u0153ur\u00a0\u00bb du site web.<\/p>\n
Vous pouvez avoir un site web fonctionnel avec seulement le c\u0153ur de WordPress, mais o\u00f9 est le plaisir dans tout cela ? Vous devez ajouter des fonctionnalit\u00e9s int\u00e9ressantes au site. C’est l\u00e0 qu’interviennent les extensions<\/a> et les th\u00e8mes WordPress<\/a>, qui font tous deux largement appel aux hooks.<\/p>\n
Dans l’exemple ci-dessus, chaque station num\u00e9rot\u00e9e est comme un hook \u00e0 l’int\u00e9rieur du c\u0153ur de WordPress. Il existe deux types de stations, comme les actions et les filtres. Chaque station comprend un type de cr\u00e9neau sp\u00e9cifique qui n’accepte que certains outils, comme les fonctions d’action et les fonctions de filtre.<\/p>\n
Toutes les stations sont plac\u00e9es \u00e0 intervalles fr\u00e9quents pour des raisons de modularit\u00e9 et d’efficacit\u00e9.<\/p>\n
Selon les exigences d’un poste particulier, nous pouvons attacher (ou accrocher) l’outil le plus appropri\u00e9 pour le travail \u00e0 ce poste sp\u00e9cifique. Ces outils sont comme les fonctions de rappel utilis\u00e9es pour interagir avec ou modifier WordPress.<\/p>\n
Certains outils peuvent modifier consid\u00e9rablement le fonctionnement de la voiture, un peu comme les rappels enregistr\u00e9s pour les actions. D’autres outils ne sont utilis\u00e9s que pour personnaliser l’apparence de la voiture, comme les rappels enregistr\u00e9s pour les filtres.<\/p>\n
Il est essentiel d’utiliser les bons outils dans les bonnes stations pour construire une voiture de premier ordre. De la m\u00eame mani\u00e8re, les hooks nous aident \u00e0 personnaliser WordPress en fonction de nos besoins particuliers.<\/p>\n
Si vous \u00e9tendez cette analogie, les extensions sont comme l’ajout de fonctions automobiles utiles telles que les airbags, la console de divertissement, le syst\u00e8me de t\u00e9l\u00e9commande sans cl\u00e9, etc. Les th\u00e8mes sont analogues \u00e0 la personnalisation de la partie visuelle de la voiture, comme la conception g\u00e9n\u00e9rale, la peinture, les jantes, etc. (voici comment personnaliser votre th\u00e8me WordPress<\/a>).<\/p>\n
O\u00f9 enregistrer les hooks et leurs fonctions ?<\/h2>\n
Il y a deux fa\u00e7ons recommand\u00e9es d’ajouter des hooks dans WordPress :<\/p>\n