WP_CLI\Utils

get_hook_description() │ WP-CLI 1.0

Return description of WP_CLI hooks used in @when tag

@param string $hook Name of WP_CLI hook

No Hooks.

Returns

String|null.

Usage

get_hook_description( $hook );

$hook(required)

.

get_hook_description() get hook description code ^{WP-CLI 2.13.0-alpha}

function get_hook_description( $hook ) {
	$events = [
		'find_command_to_run_pre'     => 'just before WP-CLI finds the command to run.',
		'before_registering_contexts' => 'before the contexts are registered.',
		'before_wp_load'              => 'just before the WP load process begins.',
		'before_wp_config_load'       => 'after wp-config.php has been located.',
		'after_wp_config_load'        => 'after wp-config.php has been loaded into scope.',
		'after_wp_load'               => 'just after the WP load process has completed.',
	];

	if ( array_key_exists( $hook, $events ) ) {
		return $events[ $hook ];
	}
	return null;
}