WP_CLI::add_wp_hook() │ public static │ WP-CLI 1.0

Add a callback to a WordPress action or filter.

add_action() needing access to add_action(). If WordPress is already loaded though, you should use add_action() add_filter()) instead.

Method of the class: WP_CLI{}

No Hooks.

Return

true.

Usage

$result = WP_CLI::add_wp_hook( $tag, $function_to_add, $priority, $accepted_args );

$tag(string) (required)

Named WordPress action or filter.

$function_to_add(mixed) (required)

Callable to execute when the action or filter is evaluated.

$priority(int)

Priority to add the callback as.
Default: 10

$accepted_args(int)

Number of arguments to pass to callback.
Default: 1

WP_CLI::add_wp_hook() WP CLI::add wp hook code ^{WP-CLI 2.8.0-alpha}

public static function add_wp_hook( $tag, $function_to_add, $priority = 10, $accepted_args = 1 ) {
	global $wp_filter, $merged_filters;

	if ( function_exists( 'add_filter' ) ) {
		add_filter( $tag, $function_to_add, $priority, $accepted_args );
	} else {
		$idx = self::wp_hook_build_unique_id( $tag, $function_to_add, $priority );

		// phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- This is intentional & the purpose of this function.
		$wp_filter[ $tag ][ $priority ][ $idx ] = [
			'function'      => $function_to_add,
			'accepted_args' => $accepted_args,
		];
		unset( $merged_filters[ $tag ] );
	}

	return true;
}