Skip to content

Improve command suggestions for taxonomies and post types #6059

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
swissspidy merged 5 commits into from
Mar 6, 2025
Merged

Improve command suggestions for taxonomies and post types #6059

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
39762ce
Command suggestion added
karthick-murugan Mar 4, 2025
9854e84
Feedback changes updated
karthick-murugan Mar 5, 2025
281250b
Features Tests update
karthick-murugan Mar 5, 2025
07d3e28
Merge branch 'main' into wpcli/command-suggestion
swissspidy Mar 5, 2025
9931116
Simplify, update tests
swissspidy Mar 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions features/runner.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,23 @@ Feature: Runner WP-CLI
Did you mean 'meta'?
"""
And the return code should be 1

Scenario: Suggest 'wp term <command>' when an invalid taxonomy command is run
Given a WP install

When I try `wp category list`
Then STDERR should contain:
"""
Did you mean 'wp term <command>'?
"""
And the return code should be 1

Scenario: Suggest 'wp post <command>' when an invalid post type command is run
Given a WP install

When I try `wp page create`
Then STDERR should contain:
"""
Did you mean 'wp post --post_type=page <command>'?
"""
And the return code should be 1
10 changes: 10 additions & 0 deletions php/WP_CLI/Runner.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,6 +396,16 @@

$suggestion = $this->get_subcommand_suggestion( $full_name, $command );

// If the functions are available, it means WordPress is available
// and has already been loaded.
if ( function_exists( '\taxonomy_exists' ) ) {
if ( \taxonomy_exists( $cmd_path[0] ) ) {
$suggestion = 'wp term <command>';
} elseif ( \post_type_exists( $cmd_path[0] ) ) {
$suggestion = "wp post --post_type={$cmd_path[0]} <command>";

Check warning on line 405 in php/WP_CLI/Runner.php

View check run for this annotation

Codecov / codecov/patch

php/WP_CLI/Runner.php#L401-L405 

Added lines #L401 - L405 were not covered by tests
}
}

return sprintf(
"'%s' is not a registered wp command. See 'wp help' for available commands.%s",
$full_name,
Expand Down