apply_filters()

Définition : apply_filters() exécute les callbacks enregistrés sur un filtre WordPress et renvoie la valeur obtenue après leurs transformations successives. Elle permet de rendre configurable une donnée sans imposer de modification au code d’origine.

Terminologie

Terme : apply_filters()

Autres appellations : Appliquer un filtre

À quoi cela sert

La fonction reçoit le nom du filtre et une valeur initiale, plus d’éventuels paramètres de contexte. WordPress transmet cette valeur à chaque callback dans l’ordre des priorités. Le résultat retourné par la dernière transformation est renvoyé au code appelant.

Dans quel contexte l’utiliser

Utiliser apply_filters() pour exposer une décision modifiable à d’autres extensions : texte affiché, tableau d’options ou seuil métier. Le contrat du filtre doit indiquer clairement le type attendu et ses limites.

Exemple concret

Un plugin permet à d’autres modules d’ajuster le nombre maximum d’éléments affichés dans son widget.

Exemple de code commenté

<?php
// Le filtre peut être modifié par un autre module.
$limite = apply_filters( 'atoolpha_widget_limite', 10 );
$limite = max( 1, min( 50, (int) $limite ) );
// Utiliser ensuite $limite dans une requête contrôlée.

Explication de l’exemple

Le filtre personnalisé reçoit le nombre 10 par défaut, puis le code force un entier compris entre 1 et 50. L’encadrement évite qu’un callback externe fournisse un nombre déraisonnable ou un type inattendu.