Description

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.

Paramètres

$tag

(string) (Requis) Le nom du hook d'un filtre.

$args

(array) (Requis) Arguments fournis aux fonctions attachées au hook $tag.

Retourne

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

Structure de la fonction apply_filters_ref_array()

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

function apply_filters_ref_array( $tag, $args ) {
    global $wp_filter, $wp_current_filter;

    // Do 'all' actions first.
    if ( isset( $wp_filter['all'] ) ) {
        $wp_current_filter[] = $tag;
        $all_args            = func_get_args(); // phpcs:ignore PHPCompatibility.FunctionUse.ArgumentFunctionsReportCurrentValue.NeedsInspection
        _wp_call_all_hook( $all_args );
    }

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

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

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

    array_pop( $wp_current_filter );

    return $filtered;
}

Fonction utilisée par apply_filters_ref_array()

_wp_call_all_hook()

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

Où trouver 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