do_action_ref_array( string $tag, array $args )
Appelle toutes les fonctions qui ont été ajouté au hook d'une action en spécifiant les arguments dans un tableau.
Paramètres
$tag
(string)requisLe nom de l'action à exécuter.
$args
(array)requisArguments fournis aux fonctions attachées au hook $tag.
Description / Informations supplémentaires
Cette fonction est identique à do_action()
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
(string) Cette fonction ne retourne rien.
Déclaration et structure de la fonction do_action_ref_array()
do_action_ref_array()
est déclarée dans le fichier wp-includes/plugin.php
à la ligne 537 :
function do_action_ref_array( $hook_name, $args ) {
global $wp_filter, $wp_actions, $wp_current_filter;
if ( ! isset( $wp_actions[ $hook_name ] ) ) {
$wp_actions[ $hook_name ] = 1;
} else {
++$wp_actions[ $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;
}
if ( ! isset( $wp_filter['all'] ) ) {
$wp_current_filter[] = $hook_name;
}
$wp_filter[ $hook_name ]->do_action( $args );
array_pop( $wp_current_filter );
}
Fonction utilisée par do_action_ref_array()
_wp_call_all_hook()
Appelle le hook 'all' qui fera défiler les fonctions attachées à celui-ci.
Où est utilisée la fonction do_action_ref_array()
dans le CMS WordPress
Exemples
$args = array( 'arg_1', true, 'foo', 'arg_4' );
do_action_ref_array( 'mon_action', $args );
do_action( 'mon_action', 'arg_1', true, 'foo', 'arg_4' );
Sources
Codex WordPress : do_action_ref_array()
Autres fonctions dans le même fichier : wp-includes/plugin.php