apply_filters_ref_array( string $tag, array $args )

Execute functions hooked on a specific filter hook, specifying arguments in an array.

Description

See also

  • apply_filters(): This function is identical, but the arguments passed to the functions hooked to $tag are supplied using an array.

Parameters

$tag

(Required) The name of the filter hook.

$args

(Required) The arguments supplied to the functions hooked to $tag.

Return

(mixed) The filtered value after all hooked functions are applied to it.

Source

File: wp-includes/plugin.php 

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();
		_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;
}

Expand Source Code View on GitHub

Related

Uses

Uses
Uses Description
wp-includes/plugin.php: _wp_call_all_hook()

Call the ‘all’ hook, which will process the functions hooked into it.

Used By

Used By
Used By Description
wp-includes/class-wp-query.php: WP_Query::set_found_posts()

Set up the amount of found posts and the number of pages (if limit clause was used) for the current query.
wp-includes/class-wp-query.php: WP_Query::get_posts()

Retrieve the posts based on query variables.
wp-includes/class-wp-network-query.php: WP_Network_Query::get_networks()

Gets a list of networks matching the query vars.
wp-includes/class-wp-network-query.php: WP_Network_Query::get_network_ids()

Used internally to get a list of network IDs matching the query vars.
wp-includes/class-wp-meta-query.php: WP_Meta_Query::get_sql()

Generates SQL clauses to be appended to a main query.
wp-includes/plugin.php: apply_filters_deprecated()

Fires functions attached to a deprecated filter hook.
wp-includes/class-wp-site-query.php: WP_Site_Query::get_sites()

Retrieves a list of sites matching the query vars.
wp-includes/class-wp-site-query.php: WP_Site_Query::get_site_ids()

Used internally to get a list of site IDs matching the query vars.
wp-includes/class-wp-comment-query.php: WP_Comment_Query::get_comments()

Get a list of comments matching the query vars.
wp-includes/class-wp-comment-query.php: WP_Comment_Query::get_comment_ids()

Used internally to get a list of comment IDs matching the query vars.
Show 5 more used by Hide more used by

Changelog

Changelog
Version Description
WP-3.0.0 Introduced.