Skip to content

Add common options reference to wp option documentation#581

Merged
swissspidy merged 3 commits intomainfrom
copilot/list-common-options-links
Feb 26, 2026
Merged

Add common options reference to wp option documentation#581
swissspidy merged 3 commits intomainfrom
copilot/list-common-options-links

Conversation

Copy link
Contributor

Copilot AI commented Feb 26, 2026

Newcomers couldn't discover common WordPress options (e.g. blogdescription) through the CLI docs, requiring external googling to find option names.

Changes

  • Adds a ## COMMON OPTIONS section to the Option_Command class docblock listing the 8 most frequently used WordPress options (siteurl, blogname, blogdescription, admin_email, default_role, timezone_string, home, blog_public) with brief descriptions
  • Links to the WordPress.org Option Reference for the full list

The section surfaces at the wp help option namespace level, making it the first place a user looks.

Original prompt

This section details on the original issue you should resolve

<issue_title>List common options and link to remaining available options</issue_title>
<issue_description>> awakekat [8:35 AM] Newbie here to WP-CLI, Just a note - I noticed that there were changes recently to the documentation to the WP-CLI. I saw there was a cut down in the click through navigation, well I liked it that way, made more sense, but I understand the change. I will make this request in the training section as well. As a newbie, I would very much like to see ALL options as examples. I am looking for a way to change the tagline by way of the CLI and it is totally not mentioned in the CLI documentation. I had to google it and find that it actually is an option: wp option update blogdescription "Something other than the WP description"

Rather than list all available options, we should list the most common and then link to the corresponding WordPress.org docs for the remainder.

This documentation should be applied to most, if not all, wp option * commands.</issue_description>

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


🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>
Copilot AI changed the title [WIP] List common options and link to remaining available options Add common options reference to wp option documentation Feb 26, 2026
@swissspidy swissspidy added this to the 2.9.0 milestone Feb 26, 2026
@swissspidy swissspidy added the scope:documentation Related to documentation label Feb 26, 2026
@swissspidy swissspidy marked this pull request as ready for review February 26, 2026 10:30
@swissspidy swissspidy requested a review from a team as a code owner February 26, 2026 10:30
@swissspidy

This comment was marked as resolved.

gemini-code-assist[bot]

This comment was marked as resolved.

@swissspidy swissspidy merged commit da81cf2 into main Feb 26, 2026
68 checks passed
@swissspidy swissspidy deleted the copilot/list-common-options-links branch February 26, 2026 10:32
@codecov
Copy link

codecov bot commented Feb 26, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

scope:documentation Related to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

List common options and link to remaining available options

2 participants