apply_filters_ref_array( string $tag, array $args )

Appelle toutes les fonctions qui ont été ajouté au hook d'un filtre en spécifiant les arguments dans un tableau.

Paramètres

$tag(string)requis

Le nom du hook d'un filtre.

$args(array)requis

Arguments fournis aux fonctions attachées au hook $tag.

Description / Informations supplémentaires

Cette fonction est identique à apply_filters() sauf que les arguments passés aux fonctions attachées à $tag sont fournis en utilisant un tableau.

Elle peut être utile quand les arguments sont déjà dans un tableau ou/et quand il y a beaucoup d'arguments à passer. Il faut juste être sûr que ceux-ci soient dans le bon ordre.

Retourne

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

Déclaration et structure de la fonction apply_filters_ref_array()

function apply_filters_ref_array( $hook_name, $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 $args[0];
    }

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

    $filtered = $wp_filter[ $hook_name ]->apply_filters( $args[0], $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_ref_array() dans le CMS WordPress

Exemples

Exécuter un filtre et passer un tableau d'arguments :
$args = array( 'arg_1', true,'foo', 'arg_4' );
apply_filters_ref_array( 'mon_filter', $args );
Revient au même que :
apply_filters( 'mon_filter', 'arg_1', true, 'foo', 'arg_4' );

Sources

Codex WordPress : apply_filters_ref_array()

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

Retour