Warn when commands override global arguments by Copilot · Pull Request #6174 · wp-cli/wp-cli

Copilot · 2025-12-20T19:42:15Z

Original prompt

This section details on the original issue you should resolve

<issue_title>Warn if overriding global argument</issue_title>
<issue_description>## Feature Request

Describe your use case and the problem you are facing

Right now, it's possible for custom commands to override global arguments such as debug or user, either accidentally or willingly.

This can make for confusing user experience because flags won't work as expected.

Plus, it makes it difficult to introduce new global arguments in the future because you won't know about it.

Describe the solution you'd like

If a command defines an argument with the same name as an existing global argument in WP-CLI, there should be a warning either when registering that command or when running the command.

Stretch goal:

This functionality could be used to more easily introduce new global arguments as well, by warning if an argument clashes with one we intend to introduce in the future. For example, in v3.0.0 we could warn you about using argument "foo", but only actually introduce it in v3.1.0, where it would error instead.
</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes Warn if overriding global argument #6173

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

… generic type Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

codecov · 2025-12-20T19:58:24Z

Codecov Report

❌ Patch coverage is 0% with 48 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
php/class-wp-cli.php	0.00%	34 Missing ⚠️
php/WP_CLI/Dispatcher/CommandFactory.php	0.00%	5 Missing ⚠️
php/WP_CLI/Dispatcher/Subcommand.php	0.00%	4 Missing ⚠️
php/WP_CLI/Dispatcher/CompositeCommand.php	0.00%	2 Missing ⚠️
php/WP_CLI/DocParser.php	0.00%	2 Missing ⚠️
php/WP_CLI/Bootstrap/LoadUtilityFunctions.php	0.00%	1 Missing ⚠️

📢 Thoughts on this report? Let us know!

Check for global argument conflicts in CommandFactory::create_subcommand() to catch conflicts in class-based commands that bypass WP_CLI::add_command() Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

Allows commands to opt-out of global argument conflict warnings by adding @skipglobalargcheck to their PHPdoc. This is useful for built-in commands that intentionally override global arguments. Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

- Remove 'This can lead to unexpected behavior' from warning to match test expectations - Use regex pattern matching for @skipglobalargcheck to prevent false positives - Ensures annotation is only detected as an actual PHPDoc tag, not in description text Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

php/WP_CLI/Dispatcher/CommandFactory.php

- Load dispatcher.php as part of LoadUtilityFunctions step - Remove separate LoadDispatcher bootstrap step - Add dispatcher.php to test bootstrap - Resolves "Call to undefined function WP_CLI\Dispatcher\get_path()" error in unit tests Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

- Remove 2>&1 redirection from Behat tests - Add public get_docparser() method to CompositeCommand - Add public has_tag() method to DocParser for checking valueless tags - Refactor command_skips_global_arg_check() to use public APIs - Rename Subcommand's get_docparser() to create_mock_docparser() to avoid conflict - Fixes PHP 8.1+ compatibility issue with reflection - Improves code maintainability by using proper public APIs Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

Avoids conflict with WP-CLI's global --user argument, which causes warnings on newer WP-CLI versions (wp-cli/wp-cli#6174). Adds functional test for --userid and --exclude_userid filters. Closes #629

Copilot AI self-assigned this Dec 20, 2025

Initial plan

b888d5b

Copilot AI assigned swissspidy Dec 20, 2025

Copilot started work on behalf of swissspidy December 20, 2025 19:42 View session

Copilot AI and others added 3 commits December 20, 2025 19:50

Add warning when command arguments conflict with global arguments

b86abdc

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

Address code review feedback - improve docblock and add comment about…

14e2756

… generic type Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

Optimize with caching and improve documentation

dedd375

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add warning for overriding global arguments in commands~~ Warn when commands override global arguments Dec 20, 2025

Copilot finished work on behalf of swissspidy December 20, 2025 19:56

Copilot AI requested a review from swissspidy December 20, 2025 19:56

Fix tests

1005b0c

swissspidy marked this pull request as ready for review December 20, 2025 20:23

swissspidy requested a review from a team as a code owner December 20, 2025 20:23

github-actions bot added breaking-change command:cli Related to 'cli' command command:config labels Dec 22, 2025

swissspidy added this to the 3.0.0 milestone Jan 20, 2026

swissspidy requested a review from Copilot January 20, 2026 15:02

Copilot started reviewing on behalf of swissspidy January 20, 2026 15:03 View session

This comment was marked as resolved.

Sign in to view

Copilot started work on behalf of swissspidy January 20, 2026 15:10 View session

Add conflict check for class-based command methods

cabe5e4

Check for global argument conflicts in CommandFactory::create_subcommand() to catch conflicts in class-based commands that bypass WP_CLI::add_command() Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

Copilot finished work on behalf of swissspidy January 20, 2026 15:16

Merge branch 'main' into copilot/warn-on-global-argument-override

ffcfdb6

This comment was marked as resolved.

Sign in to view

Merge branch 'main' into copilot/warn-on-global-argument-override

ec570bc

This comment was marked as resolved.

Sign in to view

Copilot started work on behalf of swissspidy January 20, 2026 22:31 View session

Copilot finished work on behalf of swissspidy January 20, 2026 22:42

swissspidy mentioned this pull request Jan 22, 2026

Extends documentation about commands' phpdoc possibilities/limitations wp-cli/handbook#580

Closed

1 task

swissspidy added 2 commits February 7, 2026 11:25

Merge branch 'main' into copilot/warn-on-global-argument-override

61fdc44

Address deprecation warnings

0f3e4ab

swissspidy reviewed Feb 7, 2026

View reviewed changes

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

Copilot started work on behalf of swissspidy February 7, 2026 22:38 View session

This comment was marked as resolved.

Sign in to view

Copilot finished work on behalf of swissspidy February 8, 2026 08:56

This comment was marked as resolved.

Sign in to view

swissspidy requested a review from Copilot February 8, 2026 09:39

Copilot started reviewing on behalf of swissspidy February 8, 2026 09:40 View session

This comment was marked as resolved.

Sign in to view

Update php/class-wp-cli.php

270a3ea

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

This comment was marked as resolved.

Sign in to view

Copilot started work on behalf of swissspidy February 8, 2026 10:07 View session

This comment was marked as resolved.

Sign in to view

Copilot AI requested a review from swissspidy February 8, 2026 10:12

Copilot finished work on behalf of swissspidy February 8, 2026 10:12

Merge branch 'main' into copilot/warn-on-global-argument-override

eef9160

swissspidy mentioned this pull request Mar 4, 2026

Add @skipglobalargcheck for conflicting arguments wp-cli/core-command#312

Merged

swissspidy merged commit abc7b86 into main Mar 4, 2026
67 of 68 checks passed

swissspidy deleted the copilot/warn-on-global-argument-override branch March 4, 2026 15:17

stefanfisk mentioned this pull request Mar 10, 2026

Warnings about WP_CLI_List_Command overriding global argument bonny/WordPress-Simple-History#629

Closed

swissspidy mentioned this pull request Mar 11, 2026

Add @skipglobalargcheck for conflicting arguments wp-cli/profile-command#213

Merged

Copilot AI mentioned this pull request Mar 17, 2026

Extend Commands Cookbook with PHPDoc edge-cases: aliases, repeating flags, sensitive args, global arg conflicts wp-cli/handbook#630

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Warn when commands override global arguments#6174

Warn when commands override global arguments#6174
swissspidy merged 16 commits intomainfrom
copilot/warn-on-global-argument-override

Copilot AI commented Dec 20, 2025 •

edited

Loading

Uh oh!

codecov bot commented Dec 20, 2025 •

edited

Loading

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Copilot AI commented Dec 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Comments on the Issue (you are @copilot in this section)

Uh oh!

codecov bot commented Dec 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Dec 20, 2025 •

edited

Loading

codecov bot commented Dec 20, 2025 •

edited

Loading