Include any non default hook information in CompositeCommand #5921

mrsdizzie · 2024-03-20T17:21:51Z

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.

This would be a first step towards addressing wp-cli#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 parody between that and the handbook.

templates/man.mustache

php/WP_CLI/Dispatcher/CompositeCommand.php

Co-authored-by: Pascal Birchler <pascal.birchler@gmail.com>

swissspidy · 2024-04-26T15:13:41Z

php/utils.php

+ * @return string|null
+ */
+
+function get_hook_description( $hook ) {


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

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)

This string can wrap depending on settings, so hardcode various column numbers for consistency.

mrsdizzie · 2024-04-26T20:00:58Z

@danielbachhuber tests added thanks!

php/utils.php

php/WP_CLI/Dispatcher/CompositeCommand.php

Co-authored-by: Pascal Birchler <pascal.birchler@gmail.com>

danielbachhuber

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

mrsdizzie · 2024-04-27T15:40:21Z

@danielbachhuber looks great, thanks much!

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

mrsdizzie requested a review from a team as a code owner March 20, 2024 17:21

danielbachhuber reviewed Mar 21, 2024

View reviewed changes

templates/man.mustache Show resolved Hide resolved

mrsdizzie added 2 commits April 26, 2024 11:02

Merge branch 'wp-cli:main' into main

f62b2d8

Use util helper for hook descriptions

497ec5a

mrsdizzie added this to the 2.11.0 milestone Apr 26, 2024

mrsdizzie added command:help scope:documentation contributor-day labels Apr 26, 2024

swissspidy requested a review from danielbachhuber April 26, 2024 15:12

swissspidy reviewed Apr 26, 2024

View reviewed changes

php/WP_CLI/Dispatcher/CompositeCommand.php Outdated Show resolved Hide resolved

Update php/WP_CLI/Dispatcher/CompositeCommand.php

a04d6fa

Co-authored-by: Pascal Birchler <pascal.birchler@gmail.com>

swissspidy reviewed Apr 26, 2024

View reviewed changes

danielbachhuber reviewed Apr 26, 2024

View reviewed changes

mrsdizzie added 2 commits April 26, 2024 11:37

Add behat tests

65aac15

Specify number of columns in output

9f57e82

This string can wrap depending on settings, so hardcode various column numbers for consistency.

swissspidy requested a review from danielbachhuber April 26, 2024 20:53

swissspidy reviewed Apr 26, 2024

View reviewed changes

php/utils.php Outdated Show resolved Hide resolved

swissspidy reviewed Apr 26, 2024

View reviewed changes

php/WP_CLI/Dispatcher/CompositeCommand.php Show resolved Hide resolved

mrsdizzie and others added 4 commits April 26, 2024 16:57

Apply suggestions from code review

67b101f

Co-authored-by: Pascal Birchler <pascal.birchler@gmail.com>

Tweak language and distinguish between root commands and subcommands

05ea4ec

'after_wp_load' is the standard hook, so don't need to mention it

bbc0218

Use When I run when no errors are expected

19615c4

danielbachhuber approved these changes Apr 27, 2024

View reviewed changes

danielbachhuber merged commit 6d78633 into wp-cli:main Apr 27, 2024

mrsdizzie mentioned this pull request Apr 27, 2024

Include hook details in documentation wp-cli/handbook#501

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Include any non default hook information in CompositeCommand #5921

Include any non default hook information in CompositeCommand #5921

Uh oh!

mrsdizzie commented Mar 20, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

swissspidy Apr 26, 2024

Uh oh!

mrsdizzie Apr 26, 2024 •

edited

Loading

Uh oh!

danielbachhuber left a comment

Uh oh!

mrsdizzie commented Apr 26, 2024

Uh oh!

Uh oh!

Uh oh!

danielbachhuber left a comment

Uh oh!

mrsdizzie commented Apr 27, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Include any non default hook information in CompositeCommand #5921

Include any non default hook information in CompositeCommand #5921

Uh oh!

Conversation

mrsdizzie commented Mar 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

swissspidy Apr 26, 2024

Choose a reason for hiding this comment

Uh oh!

mrsdizzie Apr 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

danielbachhuber left a comment

Choose a reason for hiding this comment

Uh oh!

mrsdizzie commented Apr 26, 2024

Uh oh!

Uh oh!

Uh oh!

danielbachhuber left a comment

Choose a reason for hiding this comment

Uh oh!

mrsdizzie commented Apr 27, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mrsdizzie commented Mar 20, 2024 •

edited

Loading

mrsdizzie Apr 26, 2024 •

edited

Loading