apply_filters( string $tag, mixed $value, mixed $args )

Description

Les fonctions de rappel attachées à un filtre sont invoquées par cette fonction. Celle-ci peut être utilisée pour créer un nouveau filtre simplement en l'appelant avec le nom d'un nouveau filtre spécifié en utilisant le paramètre $tag.

La fonction permet aussi d'ajouter de multiples arguments additionnels à passer au hook.

Paramètres

$tag

(string) (Requis) Nom du filtre (hook).

$value

(mixed) (Requis) Valeur à filtrer.

$args

(mixed) (Requis) Paramètres additionnels à passer à la fonction de rappel.

Retourne

(mixed) La valeur filtrée après que toutes les fonctions hookées aient été appliqué.

Structure de la fonction apply_filters()

Définie dans le fichier wp-includes/plugin.php à la ligne 181 :

function apply_filters( $tag, $value ) {
    global $wp_filter, $wp_current_filter;

    $args = func_get_args();

    // Do 'all' actions first.
    if ( isset( $wp_filter['all'] ) ) {
        $wp_current_filter[] = $tag;
        _wp_call_all_hook( $args );
    }

    if ( ! isset( $wp_filter[ $tag ] ) ) {
        if ( isset( $wp_filter['all'] ) ) {
            array_pop( $wp_current_filter );
        }
        return $value;
    }

    if ( ! isset( $wp_filter['all'] ) ) {
        $wp_current_filter[] = $tag;
    }

    // Don't pass the tag name to WP_Hook.
    array_shift( $args );

    $filtered = $wp_filter[ $tag ]->apply_filters( $value, $args );

    array_pop( $wp_current_filter );

    return $filtered;
}

Fonction utilisée par apply_filters()

_wp_call_all_hook()

Appelle le hook 'all' qui fera défiler les fonctions attachées à celui-ci.

Où trouver la fonction apply_filters() dans le CMS Wordpress

Rechercher

Exemple

$value_modifie = apply_filters( $value , $post_id, $post, 'save', true );

Sources

Codex Wordpress : apply_filters()

Autres fonctions dans le même fichier : wp-includes/plugin.php