Include any non default hook information in CompositeCommand

[mrsdizzie]

This would be a first step towards addressing #5838 and including details on when a specific command is run in the handbook documentation.

I've added the output to the help command as well so there will be parity between that and the handbook.

If the parent command defines a @when tag, that is passed down to all subcommands. If a subcommand has its own @when tag, it will take the place of the parent tag. If there is no @when tag defined for a parent or subcommand, it won't show any hook information with the existing assumption that everything runs on the default hook unless otherwise specified.

So now a command like wp help db reset would output:

NAME

  wp db reset

DESCRIPTION

  Removes all tables from the database.

  This command runs when the 'after_wp_config_load' hook is called, after wp-config.php has been loaded into scope.

SYNOPSIS

  wp db reset [--dbuser=<value>] [--dbpass=<value>] [--yes] [--defaults]

  Runs `DROP_DATABASE` and `CREATE_DATABASE` SQL statements using
  `DB_HOST`, `DB_NAME`, `DB_USER` and `DB_PASSWORD` database credentials
  specified in wp-config.php.

Where the after_wp_config_load hook is inherited from the parent db command.
And wp help db size would show:

NAME

  wp db size

DESCRIPTION

  Displays the database name and size.

  This command runs when the 'after_wp_load' hook is called, just after the WP load process has completed.

SYNOPSIS

  wp db size [--size_format=<format>] [--tables] [--human-readable] [--format=<format>] [--scope=<scope>] [--network] [--decimals=<decimals>] [--all-tables-with-prefix] [--all-tables] [--order=<order>] [--orderby=<orderby>]

  Display the database name and size for `DB_NAME` specified in wp-config.php.
  The size defaults to a human-readable number.

Since it defines a different hook to run on.

[swissspidy]

Can this just be a private method on the Help_Command class?

[mrsdizzie]

I believe this needs to be a public util function because the handbook project doesn't use the output of wp help and needs similar code added there as well in order to have consistency. Was going to do a PR for that one next after this is added.

[danielbachhuber]

Can we include some tests too? (Just some basic smoke test for it)

[mrsdizzie]

@danielbachhuber tests added thanks!

[danielbachhuber]

Thanks, @mrsdizzie ! I made a few small tweaks you might like to look through ^

[mrsdizzie]

@danielbachhuber looks great, thanks much!