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

Appel les fonctions qui ont été attachées à un filtre spécifique.

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.

Description / Informations supplémentaires

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.

Retourne

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

Déclaration et structure de la fonction apply_filters()

function apply_filters( $hook_name, $value, ...$args ) {
    global $wp_filter, $wp_filters, $wp_current_filter;

    if ( ! isset( $wp_filters[ $hook_name ] ) ) {
        $wp_filters[ $hook_name ] = 1;
    } else {
        ++$wp_filters[ $hook_name ];
    }

    // Do 'all' actions first.
    if ( isset( $wp_filter['all'] ) ) {
        $wp_current_filter[] = $hook_name;

        $all_args = func_get_args(); // phpcs:ignore PHPCompatibility.FunctionUse.ArgumentFunctionsReportCurrentValue.NeedsInspection
        _wp_call_all_hook( $all_args );
    }

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

        return $value;
    }

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

    // Pass the value to WP_Hook.
    array_unshift( $args, $value );

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

    array_pop( $wp_current_filter );

    return $filtered;
}
_wp_call_all_hook()

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

Où est utilisée la fonction apply_filters() dans le CMS WordPress

Exemple

Utilisation d'un filtre à plusieurs paramètres :
$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

Retour