wpseek.com
A WordPress-centric search engine for devs and theme authors



apply_filters_ref_array › WordPress Function

Since3.0.0
Deprecatedn/a
apply_filters_ref_array ( $hook_name, $args )
Parameters: (2)
  • (string) $hook_name The name of the filter hook.
    Required: Yes
  • (array) $args The arguments supplied to the functions hooked to `$hook_name`.
    Required: Yes
See:
Returns:
  • (mixed) The filtered value after all hooked functions are applied to it.
Defined at:
Codex:

Calls the callback functions that have been added to a filter hook, specifying arguments in an array.



Source

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;
}