Include hook details in documentation (#501)

mrsdizzie · web-flow · commit 7fc996aa16f2 · 2024-04-29T04:29:49.000-07:00
When a command specifies a non-default hook, include those details in handbook documentation for the command. Related: wp-cli/wp-cli#5921 Fixes: wp-cli/wp-cli#5838
diff --git a/bin/command.php b/bin/command.php
@@ -399,6 +399,16 @@ private static function gen_cmd_pages( $cmd, $parent = [], $verbose = false ) {
 		}
 		$binding['has-subcommands'] = isset( $cmd['subcommands'] ) ? [ true ] : false;
 
+		$hook_name = $cmd['hook'];
+		$hook_description = $hook_name ? Utils\get_hook_description( $hook_name ) : null;
+		if ( $hook_description && 'after_wp_load' !== $hook_name ) {
+			if ( $binding['has-subcommands'] ) {
+				$binding['description'] .= "\n\nUnless overridden, these commands run on the `$hook_name` hook, $hook_description";
+			} else {
+				$binding['description'] .= "\n\nThis command runs on the `$hook_name` hook, $hook_description";
+			}
+		}
+
 		if ( $cmd['longdesc'] ) {
 			$docs = $cmd['longdesc'];
 			$docs = htmlspecialchars( $docs, ENT_COMPAT, 'UTF-8' );
