WP_Hook::build_preinitialized_hooks( array $filters ): WP_Hook[]

Normalizes filters set up before WordPress has initialized to WP_Hook objects.

Description

The $filters parameter should be an array keyed by hook name, with values containing either:

  • A WP_Hook instance
  • An array of callbacks keyed by their priorities

Examples:

$filters = array(
    'wp_fatal_error_handler_enabled' => array(
        10 => array(
            array(
                'accepted_args' => 0,
                'function'      => function() {
                    return false;
                },
            ),
        ),
    ),
);

Parameters

$filtersarrayrequired
Filters to normalize. See documentation above for details.

Return

WP_Hook[] Array of normalized filters.

Source

public static function build_preinitialized_hooks( $filters ) {
	/** @var WP_Hook[] $normalized */
	$normalized = array();

	foreach ( $filters as $hook_name => $callback_groups ) {
		if ( $callback_groups instanceof WP_Hook ) {
			$normalized[ $hook_name ] = $callback_groups;
			continue;
		}

		$hook = new WP_Hook();

		// Loop through callback groups.
		foreach ( $callback_groups as $priority => $callbacks ) {

			// Loop through callbacks.
			foreach ( $callbacks as $cb ) {
				$hook->add_filter( $hook_name, $cb['function'], $priority, $cb['accepted_args'] );
			}
		}

		$normalized[ $hook_name ] = $hook;
	}

	return $normalized;
}

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.