add_filter()

Définition : add_filter() est la fonction WordPress utilisée pour enregistrer un callback sur un filtre. Lorsque ce filtre est appliqué, le callback reçoit une valeur, peut la modifier puis doit retourner le résultat au moteur.

Terminologie

Terme : add_filter()

Autres appellations : Ajouter un filtre, Register Filter

À quoi cela sert

La fonction prend un nom de filtre, un callback et éventuellement une priorité et un nombre d’arguments reçus. Les callbacks de même filtre s’enchaînent ; le résultat d’un callback devient l’entrée du suivant. add_filter() enregistre un traitement sans l’exécuter immédiatement.

Dans quel contexte l’utiliser

Elle convient lorsqu’une extension souhaite modifier une chaîne, une liste ou une configuration fournie par WordPress ou par une autre extension. Choisir un nom de hook existant et documenter le type attendu.

Exemple concret

Une extension souhaite modifier un extrait automatique pour ajouter un court texte de contexte sur les articles.

Exemple de code commenté

<?php
add_filter( 'get_the_excerpt', function ( $excerpt ) {
    if ( is_admin() || ! is_string( $excerpt ) ) {
        return $excerpt;
    }
    return $excerpt . ' — Suite sur notre site.';
} );

Explication de l’exemple

Le callback retourne une chaîne contenant l’extrait d’origine suivi d’une mention, mais seulement sur la partie publique. La transformation reste une opération sur les données ; aucune sortie directe n’est produite.