Skip to content

Specify scope options in same format as other arguments that have a list #321

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

Open
janw-me wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Specify scope options in same format as other arguments that have a list #321

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 10 additions & 1 deletion src/DB_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -957,7 +957,16 @@ public function import( $args, $assoc_args ) {
* : List tables based on wildcard search, e.g. 'wp_*_options' or 'wp_post?'.
*
* [--scope=<scope>]
* : Can be all, global, ms_global, blog, or old tables. Defaults to all.
* : List tables based on the scope.
* ---
* default: all
* options:
* - all - returns 'all' and 'global' tables. No old tables are returned.
* - blog - returns the blog-level tables for the queried blog.
* - global - returns the global tables for the installation, returning multisite tables only on multisite.
* - ms_global - returns the multisite global tables, regardless if current installation is multisite.
* - old - returns tables which are deprecated.
Comment on lines +960 to +968
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

Including descriptions directly within the options list in the docblock will break WP-CLI's argument validation and shell completion. The parser treats the entire line (including the description) as the valid option value. To fix this, move the descriptions to the argument's description section and keep the options block as a simple list of valid values.

	 * : List tables based on the scope.
	 *
	 * - all: returns 'all' and 'global' tables. No old tables are returned.
	 * - blog: returns the blog-level tables for the queried blog.
	 * - global: returns the global tables for the installation, returning multisite tables only on multisite.
	 * - ms_global: returns the multisite global tables, regardless if current installation is multisite.
	 * - old: returns tables which are deprecated.
	 * ---
	 * default: all
	 * options:
	 *   - all
	 *   - blog
	 *   - global
	 *   - ms_global
	 *   - old

* ---
*
* [--network]
* : List all the tables in a multisite install.
Expand Down
Loading