WP-CLI v2.12.0 Release Notes

A new release of WP-CLIWP-CLI WP-CLI is the Command Line Interface for WordPress, used to do administrative and development tasks in a programmatic way. The project page is http://wp-cli.org/ https://make.wordpress.org/cli/WP-CLI v2.12.0, is now available. For this release, we had 68 contributors collaborate to get 382 pull requests merged. 

As always, big thanks to the WP-CLI sponsors that make the continued maintenance possible.

This release includes numerous bug fixes and compatibility improvements, but we still could teach WP-CLI a few new tricks which I’ll highlight below. As always, you can also skip directly to the detailed changelog if you prefer.

If you already use WP-CLI, updating is as simple as wp cli update. Else, check out our website for recommended installation methods.

Pluck & patch commands for caches and transients

The cache and transient commands have now also learned the subtle art of plucking and patching. This means that you can directly manipulate individual entries in an array of values that these commands let you manage.

Here’s an example of how such an operation can look and how it compare to the regular cache/transient operations:

# Transient structure
# 'some_key' => ['foo' => ['bar' => 'baz']]

# Retrieve the transient value
$ wp transient get some_key --format=json
{'foo':{'bar':'baz'}}

# Retrieve the value of the foo => bar subkey
$ wp transient pluck some_key foo bar
baz

# Replace baz with bazzer
$ wp transient patch update some_key foo bar bazzer
Success: Updated transient 'some_key'.

Post lists can now handle complex query flags

When using post list, you can now use JSONJSON JSON, or JavaScript Object Notation, is a minimal, readable format for structuring data. It is used primarily to transmit data between a server and web application, as an alternative to XML. notation to provide complex query arguments to the --tax_query, --meta_query and --post_date fields.

$ wp post list --field=post_title --date_query='{"before":{"year":"2024"}}
+--------------------------+
| post_title               |
+--------------------------+
| My year in review - 2021 |
| My year in review - 2022 |
| My year in review - 2023 |
+--------------------------+

$ wp post list --field=post_title --tax_query='[{"taxonomy":"category","field":"slug","terms":"first-category"}]'
...

$ wp post list --field=post_title --meta_query='[{"key":"key2","value":"value2b"}]'
...

Post metaMeta Meta is a term that refers to the inside workings of a group. For us, this is the team that works on internal WordPress sites like WordCamp Central and Make WordPress. can be forced to only return a single value

The post meta get command now has a --single flag defaulting to true which can be negated with --no-single. This flag tells WordPress whether to only return a single value or all existing values for a given key.

# Create a post meta key for post with ID 123 that has multiple values
$ wp post meta add 123 my_meta_key value_1
$ wp post meta add 123 my_meta_key value_2
$ wp post meta add 123 my_meta_key value_4

# Retrieve a single value
$ wp post meta get 123 my_meta_key --single
value_1

# Retrieve all values
$ wp post meta get 123 my_meta_key --no-single --format=json
["value_1","value_2","value_3"]

Exclude files on core checksum verification

When running a core checksum verification, you can exclude one or more files from the checksum verification with the new --exclude=<files> flag, which takes a comma-separated list of filepaths relative to the current root.

# Make a change to the README file in the WordPress core root folder
$ echo "nonsense" > readme.html

# Run the core checksum verification
$ wp core verify-checksums --exclude='readme.html'
Success: WordPress installation verifies against checksums.

Respect requires and requires_php tags for plugins and themes

The pluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party and theme commands now understand and respect the requires and requires_php headerHeader The header of your site is typically the first thing people will experience. The masthead or header art located across the top of your page is part of the look and feel of your website. It can influence a visitor’s opinion about your content and you/ your organization’s brand. It may also look different on different screen sizes. tags when trying ot install or update extensions. A new state unavailable has been introduced to denote the updates that are newer that your current installation but for which your site does not fulfill the requirements.

This also adds new fields requires and requires_php which are displayed if they contain relevant information and otherwise hidden by default.

$ wp plugin list
+----------------+----------+-------------+---------+----------------+-------------+----------+--------------+
| name           | status   | update      | version | update_version | auto_update | requires | requires_php |
+----------------+----------+-------------+---------+----------------+-------------+----------+--------------+
| akismet        | inactive | available   | 5.1     | 5.3.5          | off         | 5.8      | 5.6.20       |
| edit-flow      | inactive | none        | 0.9.9   |                | off         | 6.0      | 8.0          |
| wp-super-cache | inactive | unavailable | 1.9.4   | 1.12.4         | off         | 6.5      | 7.0          |
+----------------+----------+-------------+---------+----------------+-------------+----------+--------------+

$ wp plugin update wp-super-cache
Warning: wp-super-cache: This update requires WordPress version 6.5, but the version installed is 6.2.
Error: No plugins updated.

More control over make-json generation

The make-json command was made more powerful again. You can not only set a custom text domain to be used, you can also define the file extension to parse.

# Use a custom text domain
$ wp i18n make-json foo-theme --domain=my-custom-domain
Success: Created 1 file.

# Include typescript files
$ wp i18n make-json foo-theme --extensions=".ts, .tsx"
Success: Created 2 files.

Force update checks on plugin|theme list

When displaying the list of plugins or themes, WP-CLI now always ensures you get fresh data. No need to manually clear transients anymore! The existing --skip-update-check flag can be used to prevent this behavior.

# Clears any update transients to trigger an update check and display results
$ wp plugin list --fields=name,status,update --force-check
+-------------+----------+--------+
| name        | status   | update |
+-------------+----------+--------+
| hello-dolly | inactive | none   |
+-------------+----------+--------+

PHPPHP PHP (recursive acronym for PHP: Hypertext Preprocessor) is a widely-used open source general-purpose scripting language that is especially suited for web development and can be embedded into HTML. https://www.php.net/manual/en/preface.php. 8.4 Compatiblity

WP-CLI is now fully compatible with PHP 8.4. This has required quite a bit of trickery and hacks to maintain compatibility with our current minimum of PHP 5.6+ at the same time. With the next release, we’ll bump the minimum PHP version to 7.2.24+, which will allow us to get rid of all these workarounds again.

Detailed Change Log

wp-cli/wp-cli-bundle

  • Fix Phar path resolution with renamed binaries [#752]
  • Deployment: Fix FILENAME env var [#696]
  • Address deprecation warnings in Behat tests [#663]

wp-cli/wp-cli

  • Replace duplicate-post plugin with debug-bar in feature tests [#6091]
  • Use forked mustache library [#6090]
  • Escape CSV output [#6089]
  • Make sure existing esc_like() takes precedence [#6088]
  • Set display_errors to stderr (lowercase) instead of STDERR [#6084]
  • Fix update step for nightlies [#6075]
  • Detect MariaDB vs MySQLMySQL MySQL is a relational database management system. A database is a structured collection of data where content, configuration and other options are stored. https://www.mysql.com/. [#6072]
  • Update WP-CLI update message [#6071]
  • Add WP_CLI_REQUIRE environment variable for including extra PHP files [#6070]
  • Remove array_column() compatibility function [#6068]
  • Support multiple files in WP_CLI_EARLY_REQUIRE [#6065]
  • Properly create missing WP-CLI configuration file when needed [#6062]
  • Improve command suggestions for taxonomies and post types [#6059]
  • Fix undefined variable issue [#6058]
  • Pass working-directory and stdin to docker scheme [#5974] & [#6057]
  • Add test for line breaks in table view [#6055]
  • Ensure code after wp-settings.php call is loaded [#6042]
  • Allow collecting PHPUnit coverage [#6041]
  • don’t forcefully exec() docker version [#6040]
  • Improve regular expression for detecting wp-settings.php [#6039]
  • Check PHP version requirement in update check [#6037]
  • Add hook to http_request() utility function [#6036]
  • Add PHPDoc for cmd_starts_with() method [#6034]
  • Update expected error message in unit tests [#6032]
  • Update outdated AJAX documentation link [#6031]
  • Add global documentation [#6017]
  • Allow remote binary customization [#6013]
  • Add configurable user agent to WP-CLI to detect in firewall logs [#5998]
  • Convert PHPUnit deprecations into exceptions [#5994]
  • Remove unused automerge workflow [#5992]
  • Fix CSV escaping deprecation notices [#5991]
  • Check for root earlier [#5987]
  • Remove use of E_STRICT for wp_debug_mode() [#5986]
  • Fix deprecation notices for ReflectionProperty::setValue() [#5984]
  • Fix “missing return type” deprecation warnings in WP_CLI\Iterators\CSV [#5983]
  • Fix implicitly nullable parameters [#5982]
  • Update Requests to v2.0.12 [#5981]
  • Update log and warning logger functions comment according to the actual functionality [#5979]
  • Add defaults and accepted values for runcommand() options in documentation [#5953]

wp-cli/handbook

  • Update documentation to include new WP_CLI_SSH_BINARY value [#559]
  • Add documentation for newly supported ENV vars [#556]
  • Update URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org for True-False Hosting [#553]

wp-cli/cache-command

  • Fix expired transients tests [#104]
  • Allow manually dispatching tests workflow [#99]
  • Make transient test more robust against added transients by coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. [#98]
  • Add pluck & patch commands for caches and transients [#89]

wp-cli/checksum-command

  • Add blank space when trimming the version [#130]
  • Add --exclude argument for verifying checksums [#123]
  • Remove unused variable [#134]
  • Don’t check missing files [#131]

wp-cli/config-command

  • Don’t require file to be writable for config has [#187]
  • Suppress output of eval(get_wp_config_code) preventing errors printing twice [#188]

wp-cli/core-command

  • Fix flaky tests due to changing download URL [#277]
  • Allow installing major version with trailing zero [#276]
  • Use existing WpOrgApi helper class [#283]
  • Add doc comment for $insecure [#281]
  • Host shouldn’t include http:// [#279]

wp-cli/cron-command

  • Harden test checking for log file [#111]

wp-cli/db-command

  • Correct error message in db search for --format=count [#267]
  • Update db search documentation [#265]
  • Add --add-drop-table to export command options [#263]
  • Improve MariaDB detection/compatibility [#280]
  • Add affected rows count for queries that can modify data in db query [#277]
  • Don’t hardcode MySQL command names [#275]

wp-cli/entity-command

  • Add missing options header in signup list command [#508]
  • Ensure user update returns non-zero exit code for invalid users [#527]
  • Make term-migrate test more robust [#524]
  • Add a flag for getting post meta as a single value or not [#523]
  • Add JSON input support for tax_query and meta_query [#522]
  • Add JSON input support for date_query argument [#520]
  • wp option – new autoload values in autoload filterFilter Filters are one of the two types of Hooks https://codex.wordpress.org/Plugin_API/Hooks. They provide a way for functions to modify data of other functions. They are the counterpart to Actions. Unlike Actions, filters are meant to work in an isolated manner, and should never have side effects such as affecting global variables and output. [#515]
  • Return a proper WP_Error object when failing to update a comment [#514]
  • Add test cases asserting post/term update error exit codes [#513]
  • Safeguard remove cap from collisions with roles [#530]

wp-cli/export-command

  • Use get_post_stati() instead of get_post_statuses() to support all registered post statuses in export [#121]

wp-cli/extension-command

  • Use strpos() instead of str_contains() in get_wporg_data() function [#432]
  • Don’t use transient values when doing plugin|theme list [#446]
  • Fix fatal error issue in in_array() function [#445]
  • Support requires and requires_php in plugin|theme list and plugin|theme update commands [#440]
  • Update logic when deleting and uninstalling plugins [#438]
  • Check WordPress and PHP requirements before installing a theme or plugin [#436]
  • Add --force-check flag to wp plugin list and wp theme list. [#426]
  • Cache certain GitHubGitHub GitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/ URLs [#385]

wp-cli/i18n-command

  • Convert PHPUnit deprecations to exceptions [#413]
  • make-pot: scan any theme.json file in any level [#424]
  • Add ability to pass extensions to make-json command [#439]
  • Update schema fallback files [#431]
  • make-json: Add new --domain argument [#430]
  • update-po: merge X-Domain header [#429]
  • Add php-format and js-format flags [#428]

wp-cli/language-command

  • Mention site switch-language in readme [#159]
  • Allow filtering languages by multiple statuses [#162]

wp-cli/php-cli-tools

  • Example code: remove use of E_STRICT [#175]
  • Fix implicitly nullable parameters [#173]
  • Replace tabs in tables with 4 spaces [#181]
  • Properly handle line breaks in column value [#179]
  • Support line breaks and tab replacement in tabular table values [#182]
  • Fix removal of trailing tab / whitespace in tabular table [#184]
  • Avoid deprecation warnings in newer PHP [#185]

wp-cli/rewrite-command

  • Improve warning message in rewrite flush [#69]

wp-cli/scaffold-command

  • Convert PHPUnit deprecations to exceptions [#348]
  • Add dependency checks and error handling for svn and download tools [#345]
  • Accept Bitbucket as valid CI in scaffold plugin [#340]
  • Update Bitbucket CI [#339]
  • Update templates for child themeChild theme A Child Theme is a customized theme based upon a Parent Theme. It’s considered best practice to create a child theme if you want to modify the CSS of your theme. https://developer.wordpress.org/themes/advanced-topics/child-themes/. scaffolding [#342]
  • Update custom post typeCustom Post Type WordPress can hold and display many different types of content. A single item of such a content is generally called a post, although post is also a specific post type. Custom Post Types gives your site the ability to have templated posts, to simplify the concept. and taxonomyTaxonomy A taxonomy is a way to group things together. In WordPress, some common taxonomies are category, link, tag, or post format. https://codex.wordpress.org/Taxonomies#Default_Taxonomies. scaffolding [#341]
  • Update GitLab CI configuration file [#338]
  • Remove grunt from plugin scaffolding [#337]

wp-cli/shell-command

  • Add missing do construct [#68]

wp-cli/wp-config-transformer

  • Add read-only option for WPConfigTransformer [#54]
  • Add a branch-alias for dev-main [#55]
  • Deletion of constants deletes more lines than expected [#53]

Contributors

@9ete, @amirhmoradi, @baizmandesign, @benjaminprojas, @BhargavBhandari90, @cliffordp, @daalderp, @dac514, @danielbachhuber, @dd32, @dkoston, @dlind1, @drzraf, @elenachavdarova, @ernilambar, @gedex, @gitlost, @greatislander, @herregroen, @i-am-chitti, @iDschepe, @imrraaj, @itsmekopila, @janw-me, @jenkoian, @jkrrv, @jrfnl, @karthick-murugan, @l3ku, @localheinz, @marksabbath, @matiasbenedetto, @matzeeable, @meszarosrob, @michaelw85, @michaelzangl, @mostafasoufi, @mrsdizzie, @oandregal, @ocean90, @ouikhuan, @PARTHVATALIYA, @pbiron, @peterwilsoncc, @petitphp, @pfefferle, @pmbaldha, @ponsfrilus, @pwtyler, @ramonjd, @rodrigoprimo, @Roy-Orbison, @saas786, @sabithahmd, @sdnunca, @shendy-a8c, @shreya0204, @siliconforks, @strarsis, @swissspidy, @todeveni, @Tug, @tyrann0us, @wojsmol, @wpeople-dev, @WPprodigy, @yousan

#release, #v2-12-0

WP-CLI v2.11.0 Release Notes

A new release of WP-CLIWP-CLI WP-CLI is the Command Line Interface for WordPress, used to do administrative and development tasks in a programmatic way. The project page is http://wp-cli.org/ https://make.wordpress.org/cli/WP-CLI v2.11.0, is now available. For this release, we had 61 contributors collaborate to get 274 pull requests merged. 

As always, big thanks to the WP-CLI sponsors that make the continued maintenance possible.

This is a small release that fixes a lot of small and not so small bugs, but we also have a couple of new features that I’ll want to highlight. As always, you can also skip directly to the detailed changelog if you prefer.

If you already use WP-CLI, updating is as simple as wp cli update. Else, check out our website for recommended installation methods.

Thank you for providing the additional details on the pull requests. I’ll go through each one and provide improved highlights with examples and usage details:

Improved CSV Handling

The CSV reading functionality has been enhanced to properly handle multi-line values. This fix ensures that complex CSV data can be processed correctly, improving the reliability of commands that work with CSV input.

Example of a CSV file that can now be correctly processed:

id,name,description
1,"Product A","This is a
multi-line
description"
2,"Product B","Another description"

New Signup Management Commands

New commands have been added for managing signups on multisiteMultisite Multisite is a WordPress feature which allows users to create a network of sites on a single WordPress installation. Available since WordPress version 3.0, Multisite is a continuation of WPMU or WordPress Multiuser project. WordPress MultiUser project was discontinued and its features were included into WordPress core.https://codex.wordpress.org/Create_A_Network. installations:

  • wp user signup list: List signups
  • wp user signup get: Get details about a signup
  • wp user signup activate: Activate one or more signups
  • wp user signup delete: Delete one or more signups

Example usage:

# List all signups
$ wp user signup list

# Activate a signup
$ wp user signup activate johndoe@example.com

# Delete a signup
$ wp user signup delete 123

New Site Generator Command

A new wp site generate command has been added to create multiple sites programmatically in a multisite installation. This is useful for testing or development purposes.

Example usage:

# Generate 10 new sites
$ wp site generate --count=10

# Generate sites with a specific slug
$ wp site generate --count=2 --slug=testsite

GitHubGitHub GitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/ Release Installation Support

The extension command now supports installing plugins and themes directly from GitHub releases. This feature allows users to easily install and manage extensions hosted on GitHub without manual downloads.

Example usage:

# Install a plugin from its latest GitHub release
$ wp plugin install https://github.com/username/plugin-name/releases/latest

# Install a specific version of a theme from GitHub
$ wp theme install https://github.com/username/theme-name/releases/tag/v1.2.3

Improved PluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party Management

A new --recently-active option has been added to the plugin list command, allowing users to quickly identify and manage plugins that have been recently active on their site.

Example usage:

# List recently active plugins
$ wp plugin list --recently-active

# Activate all recently active plugins
$ wp plugin activate $(wp plugin list --recently-active --field=name)

Option to Delete Unknown Image Sizes

A new --delete-unknown flag has been added to the wp media regenerate command. This allows users to remove files and image metadata for image sizes that no longer exist in the site’s configuration, without regenerating other thumbnails.

Example usage:

# Remove unknown image sizes for all images
$ wp media regenerate --delete-unknown

# Remove unknown image sizes for a specific image
$ wp media regenerate 123 --delete-unknown

This feature is particularly useful for cleaning up after changing image size configurations or removing plugins that added custom image sizes.

User Existence Check Command

A new wp user exists command has been added, similar to the existing wp post exists command. This allows for quick checks on whether a user exists in the WordPress database.

Example usage:

# The user exists.
$ wp user exists 1337
Success: User with ID 1337 exists.
$ echo $?
0

# The user does not exist.
$ wp user exists 10000
$ echo $?
1

Fish Shell Completion Support

WP-CLI now supports command completion for the Fish shell, expanding its compatibility beyond Bash and Zsh. This addition makes it easier for Fish shell users to work with WP-CLI commands.

Detailed change log

To avoid too much noise in the list above, the following types of pull requests have been omitted:

  • PRs that only bumped dependencies to their latest version.
  • PRs that only fixed a typo in the documentation.
  • PRs that add a Composer script.

wp-cli/wp-cli-bundle

  • Update versions of WP-CLI used in tests [#658]
  • Stop testing WordPress latest version on PHPPHP PHP (recursive acronym for PHP: Hypertext Preprocessor) is a widely-used open source general-purpose scripting language that is especially suited for web development and can be embedded into HTML. https://www.php.net/manual/en/preface.php. < 7.2 [#651]

wp-cli/wp-cli

  • Add fish shell completion [#5954]
  • Add defaults and accepted values for runcommand() options in documentation [#5953]
  • Address warnings with filenames ending in full stop on Windows [#5951]
  • Fix unit tests [#5950]
  • Update copyright year in license [#5942]
  • Fix breaking multi-line CSV values on reading [#5939]
  • Fix broken GutenbergGutenberg The Gutenberg project is the new Editor Interface for WordPress. The editor improves the process and experience of creating new content, making writing rich content much simpler. It uses ‘blocks’ to add richness rather than shortcodes, custom HTML etc. https://wordpress.org/gutenberg/ test [#5938]
  • Update docker runner to resolve docker path using /usr/bin/env [#5936]
  • Fix inherit path in nested directory [#5930]
  • Minor docblock improvements [#5929]
  • Add Signup fetcher [#5926]
  • Ensure the alias has the leading @ symbol when added [#5924]
  • Include any non-default hook information in CompositeCommand [#5921]
  • Correct completion case when it ends in = [#5913]
  • Fix inline comments [#5912]
  • Update inline comments [#5910]
  • Add a real-world example for cli has-command [#5908]
  • Fix typos [#5901]
  • Avoid PHP deprecation notices in PHP 8.1.x [#5899]

wp-cli/handbook

  • Update handbook for v2.11.0 release [#531]
  • Add missing scaffold package markdown files [#529]
  • Fix Undefined array key warning [#525]
  • Add files autoloader for bin/command.php [#524]
  • Small typo correction [#523]
  • Fix documentation generation error [#520]
  • Add Yoast WP-CLI command to tools.md [#517]
  • Add search and replace quick start & adding new command [#515]
  • Add Composer package name [#514]
  • Clean up hosting links [#513]
  • Add to hosting-companies.md [#512]
  • Remove invalid link from handbook [#511]
  • Update contributor dayContributor Day Contributor Days are standalone days, frequently held before or after WordCamps but they can also happen at any time. They are events where people get together to work on various areas of https://make.wordpress.org/ There are many teams that people can participate in, each with a different focus. https://2017.us.wordcamp.org/contributor-day/ https://make.wordpress.org/support/handbook/getting-started/getting-started-at-a-contributor-day/. page for WCEU 2024 [#510]
  • Add documentation on Fish completions [#508]
  • Add code quality setup [#506]
  • Fix global parameters 404 link [#504]
  • Fix release checklist hyperlink [#503]
  • Fix broken link for the global parameters hyperlink [#502]
  • Include hook details in documentation [#501]
  • Add link to contribution tutorial videos [#500]
  • Update hosting-companies.md [#499]
  • Refresh the Hack Day page for April 2024 [#498]
  • Fix branch name in common issues handbook page [#497]
  • Fix common issues title [#496]
  • Fix broken link [#494]
  • Add Hack Day page to manifest [#492]
  • Separate out the WP-CLI Hack Day and WordCampWordCamp WordCamps are casual, locally-organized conferences covering everything related to WordPress. They're one of the places where the WordPress community comes together to teach one another what they’ve learned throughout the year and share the joy. Learn more. Contributor Day docs [#490]
  • Update running-commands-remotely.md [#489]
  • Update brew formula link [#487]
  • Update installing.md [#481]

wp-cli/cache-command

  • Update failing tests after new transient in WP coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. [#97]

wp-cli/config-command

  • Improve messaging when shuffling salts [#177]
  • Fix incorrect message shuffling salt in PHP 5.6 [#176]
  • Update config commands examples [#174]
  • Refactor config create command [#181]

wp-cli/core-command

  • Remove extraneous argument in core update example [#255]
  • Fix --format in core check-update command [#253]
  • Update core commands docs [#251]

wp-cli/cron-command

  • Fix cron commands examples [#102]
  • Add --all flag to cron event delete [#98]

wp-cli/db-command

  • Add note about multisite usage in db query docs [#251]
  • Enable --format=<format> for db search [#247]
  • Update tests after change in WP trunk version [#257]

wp-cli/embed-command

  • Update examples for embed commands [#75]

wp-cli/entity-command

  • Avoid time dependent test in user application-password [#499]
  • Support new upstream autoload options [#496]
  • Support nickname when creating user [#495]
  • Use twentytwelve theme in menu location test [#494]
  • Add examples for option set-autoload and option get-autoload commands [#492]
  • Add missing ## OPTIONS in CommandWithTerms class [#487]
  • Add user exists command [#486]
  • Accept user login and email in user spam and user unspam commands [#485]
  • Update doc for user spam and user unspam command [#483]
  • Validate reassigning user in user delete command [#482]
  • Fix warning message in user spam command [#481]
  • Add missing application-password and site meta subcommands to readme [#478]
  • Introduce --format=ids in user application-password list [#475]
  • Fix dynamic property issue in user session class [#470]
  • Fix PHP notice in comment recount with invalid ID [#469]
  • Fix example for site deactivate command [#468]
  • Update examples in user commands [#467]
  • Update term commands examples [#466]
  • Update example output for comment delete command [#465]
  • Fix menu command output examples [#462]
  • Add site generate command [#498]
  • Add commands for managing signups on multisite [#489]

wp-cli/extension-command

  • Improve warning message for installing and activating multiple themes [#419]
  • Replace user-switching plugin from feature tests [#418]
  • Update the theme in feature tests [#417]
  • Show additional plugin headerHeader The header of your site is typically the first thing people will experience. The masthead or header art located across the top of your page is part of the look and feel of your website. It can influence a visitor’s opinion about your content and you/ your organization’s brand. It may also look different on different screen sizes. values in plugin get <plugin> output [#414]
  • Add tested_up_to field [#413]
  • Warn when supplying multiple themes with theme install --activate [#408]
  • Fix plugin commands examples [#403]
  • Update theme commands examples [#401]
  • Correct parameter type in ParseThemeNameInput trait [#400]
  • Add --recently-active option in plugin list command [#424]
  • Fix visibility in command class methods [#423]
  • Add support for GitHub release installation [#421]
  • Replace edit-flow plugin by debug-bar in feature tests [#427]

wp-cli/i18n-command

  • Skip strings without translation in make-php [#389]
  • Add more headers to PHP translation files [#388]
  • Use relative paths for file header references [#384]
  • Translate “description” field from theme.json [#408]
  • Revert changes to extract title from styles.blocks.variations [#407]
  • find title string within styles.blocks.variations in theme.json [#405]
  • Add tests for rspack and esbuild bundle output [#404]
  • Fix deprecation warnings in unit tests [#402]
  • Use relative paths for file header references (Windows fix) [#400]
  • Ensure that the POT file uses the same license as the theme [#399]
  • Add examples for i18n update-po command [#392]
  • Add examples for i18 make-pot [#390]

wp-cli/language-command

  • Update examples for language command [#145]
  • Update examples for language core command [#142]
  • Update examples for language theme command [#141]
  • Update examples for language plugin command [#140]
  • Improve warning message for unavailable language pack [#139]
  • Update doc for language core install command [#153]
  • Add --format=count in language list commands [#151]
  • Update feature tests for language core update [#149]

wp-cli/maintenance-mode-command

  • Add missing OPTIONS heading in maintenance-mode activate command [#28]

wp-cli/media-command

  • Fix incorrect image sizes in media image-size command [#192]
  • Remove extraneous error check [#191]
  • Update media commands examples [#189]
  • Optimize memory consumption when querying attachments [#188]
  • Add option to delete unknown image sizes [#199]

wp-cli/package-command

  • Update docs and examples for package commands [#186]
  • Fix failing test [#185]
  • Fix failing PHPUnit tests [#188]

wp-cli/php-cli-tools

  • Fix unit tests [#172]

wp-cli/scaffold-command

  • Update theme tests to remove p2 and use twentytwelve [#336]
  • Correct plugin main file in bootstrap in scaffolded test [#335]
  • Scaffold theme test should work in PHP greater than 8.0 [#334]
  • Add GitHub as valid CI for plugin scaffold and theme scaffold [#331]
  • Update scaffold command examples [#329]

wp-cli/search-replace-command

  • Fix tests after change in WordPress trunk [#195]
  • Fix test for WordPress trunk [#197]

wp-cli/super-admin-command

  • Add IDs as format for super admin list [#60]
  • Correct super-admin commands examples [#57]

wp-cli/widget-command

  • Replace p2 theme with twentytwelve in feature test [#61]

wp-cli/wp-config-transformer

  • Fix failing PHPUnit tests [#52]

Contributors

#release, #v2-11-0

Fifteen Merged PRs for WP-CLI Hack Day 2024

The third ever WP-CLIWP-CLI WP-CLI is the Command Line Interface for WordPress, used to do administrative and development tasks in a programmatic way. The project page is http://wp-cli.org/ https://make.wordpress.org/cli/ Hack Day is now complete!

It was really nice to connect with folks both on Zoom and in SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/.. With how much async collaboration we have in the project, it’s quite refreshing to discuss bugs and implementations in real-time. I think we had a Zoom room open for over seven hours.

Many thanks to everyone that participated! 🙏 @abhi3315, @brianhenryie, @danielbachhuber, Deepak Kumar, isla w, @johnbillion, @kau-boy, @mkrndmane, @meszarosrob, @petitphp, @rabmalin, @schlessera, @swissspidy, Takshil Kunadia, @tfirdaus, @thelovekesh

We had 15 pull requests that were merged during the event:

  1. Update docker runner to resolve docker path using /usr/bin/env
  2. Add Signup fetcher
  3. Fix broken Gutenberg test
  4. Warn when supplying multiple themes with theme install --activate
  5. Add wp-versions-data-fetcher workflow
  6. Improve warning message for install and activate multiple themes
  7. Fix breaking multi-line CSV values on reading
  8. Ensure that the POT file use the same license as the theme
  9. Fix inherit path in nested directory
  10. Update failing tests after new transient in WP core
  11. Add tested_up_to field
  12. Correct plugin main file in bootstrap in scaffolded test
  13. Include any non default hook information in CompositeCommand
  14. Add support for GitHub release installation
  15. Enable --format=<format> for db search

In addition to those, we had an additional 6 pull requests with substantial progress during the event that aren’t yet merged:

See you at the next WP-CLI Hack Day!

Save the date! WP-CLI Hack Day on Friday, April 26th

We’re happy to announce the third ever WP-CLIWP-CLI WP-CLI is the Command Line Interface for WordPress, used to do administrative and development tasks in a programmatic way. The project page is http://wp-cli.org/ https://make.wordpress.org/cli/ Hack Day! 🤓🎈

On 🕓 Friday, 26th April 2024 we’ll officially kick off the WP-CLI Hack Day at 🕗 Friday, 26th April 2024, 0800 UTC. From that point on, @schlessera, @swissspidy, and I will be generally available in Slack #cli channel and on the GitHub wp-cli organization to onboard new contributors, help people pick issues to work on and remove hurdles that keep them from finishing their PRs. This will continue more or less without interruption during the entire event.

From 🕓 Friday, 26th April 2024, 0900 UTC to Friday, 26th April 2024, 1000 UTC and then again between 🕓 Friday, 26th April 2024, 1500 UTC and Friday, 26th April 2024, 1600 UTC we’ll have an open video chat that everyone can join, where we can discuss remaining issues live and chat about the progress we’ve made. This extended video chat session will then conclude the event. Shortly after 🕕 Friday, 26th April 2024, 2200 UTC, I will post a make/cli blog post about the progress we were able to make during the allotted time frame.

The 🎯 goal for this WP-CLI Hack Day is both simple and ambitious:

Finish the day with 2️⃣0️⃣ pull requests that have been merged during the event ❗️

Everyone is welcome to participate! This event is supposed to be fun and inspiring, and we expect people to help each other make progress along the way.

Let’s make this happen! 👍 The official hashtag for the event is #hackwpcli 📣

#hack-day

WP-CLI v2.9.0 release date: October 25th

The v2.9.0 release of WP-CLIWP-CLI WP-CLI is the Command Line Interface for WordPress, used to do administrative and development tasks in a programmatic way. The project page is http://wp-cli.org/ https://make.wordpress.org/cli/ is scheduled to be published on Wednesday, October 25th 2023.

In addition to a lot of bug fixes and enhancements, this release is also expected to address the last known compatibility issues with PHPPHP PHP (recursive acronym for PHP: Hypertext Preprocessor) is a widely-used open source general-purpose scripting language that is especially suited for web development and can be embedded into HTML. https://www.php.net/manual/en/preface.php. 8.2 and the upcoming WordPress 6.4 version.

The release candidateRelease Candidate A beta version of software with the potential to be a final product, which is ready to release unless significant bugs emerge. for this release will already be available sometime during the week prior, to allow for early testing. We will announce the availability of that release candidate in the #hosting-community channel to allow hosting providers to do early smoke testing.

#release, #v2-9-0

WP-CLI v2.8.0 release date

The v2.8.0 release of WP-CLIWP-CLI WP-CLI is the Command Line Interface for WordPress, used to do administrative and development tasks in a programmatic way. The project page is http://wp-cli.org/ https://make.wordpress.org/cli/ is scheduled to be published on Wednesday, May 3rd 2023.

Amongst others a multitude of bug fixes and some new features, we’re also expecting this release to fix all known PHPPHP PHP (recursive acronym for PHP: Hypertext Preprocessor) is a widely-used open source general-purpose scripting language that is especially suited for web development and can be embedded into HTML. https://www.php.net/manual/en/preface.php. 8.2 issues within WP-CLI itself.

The release candidateRelease Candidate A beta version of software with the potential to be a final product, which is ready to release unless significant bugs emerge. for this release will already be available sometime during the week prior, to allow for early testing. We will announce the availability of that release candidate in the #hosting-community channel to allow hosters to do early smoke testing.

#release, #v2-8-0

Good issues for new and existing contributors

Want to submit your first pull request to WP-CLIWP-CLI WP-CLI is the Command Line Interface for WordPress, used to do administrative and development tasks in a programmatic way. The project page is http://wp-cli.org/ https://make.wordpress.org/cli/? We’ve identified a few good first issues for you to get your feet wet:

If you’ve contributed to WP-CLI before, we have 77 open bugs we’d love your assistance sorting through. 😁

Read through the contributing guide for details on how to get started. Feel free to ask questions on the specific issue, or join us in the #cli channel with any questions you might have.

Thanks for your help!

WP-CLI v2.7.0 Release Notes

A new release of WP-CLIWP-CLI WP-CLI is the Command Line Interface for WordPress, used to do administrative and development tasks in a programmatic way. The project page is http://wp-cli.org/ https://make.wordpress.org/cli/ is available as of today: WP-CLI v2.7.0. For this release, we had 48 contributors collaborate to get 195 pull requests merged. 🎉

As always, big thanks to the WP-CLI sponsors that make the continued maintenance possible. ❤️

This is a small release with the main purpose of getting some much needed bug fixes into a stable version. Nevertheless, we also have a few new features that I’ll want to highlight. As always, you can also skip directly to the detailed changelog if you prefer.

Support for docker-compose run

The --ssh flag and ssh configuration key (and along with them the remote execution aliases) have learned a new scheme: docker-compose-run:.

The docker: and docker-compose: schemes for the ssh option are useful, but they only work when the target container is already running and therefore supports running a shell command via docker[-compose] exec.

Some environments, for example the wordpress-develop local development environment, run WP-CLI via a container that only starts when needed and therefore requires the use of run instead of exec.

With the support of the new docker-compose-run scheme in place you could put the following config into the root of any project that uses wordpressdevelop/cli and then simply use wp <cmd> instead of npm run env:cli -- <cmd> or docker-compose run cli -- <cmd>.

# wp-cli.yml
ssh: docker-compose-run:cli

Customizable global parameters

It was not previously possible to extend the list of parameters without modifying the WP-CLI source files. While we are still considering different options for making the global parameters extensibleExtensible This is the ability to add additional functionality to the code. Plugins extend the WordPress core software. via a clean APIAPI An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways., we already needed a short-term solution for a specific use case.

Because of this, we now introduced a set of small changes that allow the global parameters to be adapted on a “platform level”. This means that, for now, you can change the global parameters, but only if you control the environment in which WP-CLI is being executed in. This functionality works through the combination of the following changes:

  • A new constant WP_CLI_CONFIG_SPEC_FILTER_CALLBACK is being checked to filterFilter Filters are one of the two types of Hooks https://codex.wordpress.org/Plugin_API/Hooks. They provide a way for functions to modify data of other functions. They are the counterpart to Actions. Unlike Actions, filters are meant to work in an isolated manner, and should never have side effects such as affecting global variables and output. the array that the config-spec.php file has provided.
  • A new environment variable WP_CLI_EARLY_REQUIRE is checked to allow for the environment to provide extra PHPPHP PHP (recursive acronym for PHP: Hypertext Preprocessor) is a widely-used open source general-purpose scripting language that is especially suited for web development and can be embedded into HTML. https://www.php.net/manual/en/preface.php. bootstrapping logic.

You can use both of these to let the WP_CLI_EARLY_REQUIRE load a PHP file that defines a new filter callback and then sets the WP_CLI_CONFIG_SPEC_FILTER_CALLBACK to point to that filter.

This test snippet shows an example of how these two mechanisms can be used in tandem:

Download WordPress CoreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. files without extracting them

Previously, you could already use the core download command not only to retrieve the set of files from the WordPress central servers. But we did not have a way to solely download a ZIP archive of WordPress Core instead.

Now you can do so via the --extract flag. This is on by default to keep with the current behavior, but you can now switch extraction off by adding the --no-extract flag.

Why would you do that, if it is a single file download you could also trigger via wget or curl? Well, for one, it uses the HTTPHTTP HTTP is an acronym for Hyper Text Transfer Protocol. HTTP is the underlying protocol used by the World Wide Web and this protocol defines how messages are formatted and transmitted, and what actions Web servers and browsers should take in response to various commands. stack of WordPress/WP-CLI to do the download. And what’s more, it allows you to use the smart WP-CLI flags like --version to automatically retrieve the file from the right URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org.

Directly install a specific locale

Previously, when you wanted to install a locale of WordPress Core other than the default en_US, you had to first run a wp core install, and then switch the locale in a second step.

Now, WP-CLI allows you to select a specific locale right away via core install‘s new --locale flag.

Ordering of the db size results

To quickly see what the biggest tables in your installation are, you can now make use of the new --order and --orderby flags. The most useful example would be to use --orderby=size --order=desc to get the largest tables first.

Clean duplicate metaMeta Meta is a term that refers to the inside workings of a group. For us, this is the team that works on internal WordPress sites like WordCamp Central and Make WordPress. values

Due to limitations of the WordPress database schema, the WordPress importer can end up inadvertently creating duplicate post meta entries if the import is run multiple times.

WP-CLI has now learned a new command to remove duplicate post meta values for a given meta key.

# Delete duplicate post meta.
wp post meta clean-duplicates 1234 enclosure
Success: Cleaned up duplicate 'enclosure' meta values.

Exclude select plugins on certain pluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party commands

The plugin commands activate, deactivate, delete and uninstall now accept an additional --exclude flag if you use their --all flag.

The --exclude accepts a comma-separated list of plugin slugs, and allows you to do operations in the vein of “deactivate all plugins except for these few ones”.

# Deactivate all plugins with exclusion
$ wp plugin deactivate --all --exclude=hello,wordpress-seo
Plugin 'contact-form-7' deactivated.
Plugin 'ninja-forms' deactivated.
Success: Deactivated 2 of 2 plugins.

Multiple changes to the i18n support

In our ongoing effort to further internationalization support within GutenbergGutenberg The Gutenberg project is the new Editor Interface for WordPress. The editor improves the process and experience of creating new content, making writing rich content much simpler. It uses ‘blocks’ to add richness rather than shortcodes, custom HTML etc. https://wordpress.org/gutenberg/, we have made yet another around of i18n changes and additions.

Most of the changes deal with changes to block.json and theme.json, in order to support all the latest fields and mechanisms.

Also, there is now a new update-po command. Up until now, if you added a new translation to one of your plugins, you could update the messages.pot file with make-pot, but you’d have to update existing po files with the new translation by hand. With the new i18n update-po (which is a WP-CLI alternative to msgmerge), you get around this without requiring manual edits.

And finally, i18n now supports PHP Blade templates as an additional input format to parse for translations.

Detailed change log

To avoid too much noise in the list above, the following types of pull requests have been omitted:

  • PRs that only bumped dependencies to their latest version.
  • PRs that only fixed a typo in the documentation.
  • PRs that add an allow-plugins rule to Composer

wp-cli/wp-cli-bundle

  • Add eftect/bladeone to PHAR for i18n-command [#417]

wp-cli/wp-cli

  • Add support for docker-compose run to the --ssh option [#5637]
  • Internalize global_terms_enabled() [#5684]
  • Add cache directory path to cli info output [#5681]
  • Always return PHP_BINARY when using a PHAR bundle [#5672]
  • Load config-spec.php in a “filterable” way [#5664]
  • Use different action for admin context logic [#5663]
  • Require v3.1.6 of wp-cli/wp-cli-tests [#5659]
  • Address some PHP 8.1 deprecation notices [#5658]
  • Document return type for WP_CLI::halt() as never [#5651]
  • Fix skip theme tests [#5646]
  • Add missing $upgrade argument to enable_maintenance_mode filter [#5630]
  • Handle optional option values in SynopsisParser::render() [#5618]
  • Add missing relative namespace [#5616]

wp-cli/handbook

  • Add additional instructions to override the DB test credentials. [#410]

wp-cli/cache-command

  • Make transients deletion test more robust [#74]

wp-cli/config-command

  • Prevent WP_DEBUG already defined when provided via --extra-php [#144]

wp-cli/core-command

  • Add --extract flag to core download [#204]
  • Update the link in the docblock of core multisite-convert command [#201]
  • Add --locale parameter [#133]
  • Remove only themes/plugins folders on --skip-content [#212]

wp-cli/db-command

  • Fix broken tests due to DB connection failure error message change [#224]
  • Stop reordering most MySQLMySQL MySQL is a relational database management system. A database is a structured collection of data where content, configuration and other options are stored. https://www.mysql.com/. arguments [#221]
  • Add support for --order, --orderby flags in db size command [#226]

wp-cli/entity-command

  • Use https in post generate example [#355]
  • Support filtering for users without a role with --role=none [#360]
  • Sync user-contributed example to user delete [#358]
  • Fix JSONJSON JSON, or JavaScript Object Notation, is a minimal, readable format for structuring data. It is used primarily to transmit data between a server and web application, as an alternative to XML. formatting in feature file [#368]
  • Add post meta clean-duplicates <id> <key> command [#366]
  • Document primary_blog meta key for users [#365]
  • Allow user_url to be set with user create [#372]
  • Show error when parameter is missing in option patch [#371]
  • Use current_time() for setting the default value for user_registered in user create [#378]
  • Add examples for option patch command [#375]

wp-cli/export-command

  • Fix test for attachment serialization [#96]

wp-cli/extension-command

  • Add optional --exclude=<name> argument for multiple plugin commands [#321]
  • Fix broken Behat tests [#318]
  • Add title/description for mu-plugins [#305]
  • Avoid deleting parent of active theme unless using --force [#324]
  • Exit with 0 when checked theme is active parent theme [#327]

wp-cli/i18n-command

  • Extract pattern metadata (title & description) [#312]
  • Look for theme.json files in the styles directory of a theme [#311]
  • Translate title field from theme.json [#306]
  • Add support for PHP-Blade files [#304]
  • Fix include logic where include path is subdirectory of excluded path [#302]
  • Add missing docs for make-mo command [#315]
  • Add update-po command [#316]
  • Improve warnings for strings with different comments [#318]
  • Extract some shared code into FileDataExtractor [#321]
  • Update and combine theme.json and block.json extractors [#319]
  • Improve theme patterns and styles lookup [#320]
  • Use preg_match instead of mb_ereg [#317]
  • Prefix JSON files with text domain if needed [#313]

wp-cli/import-command

  • Bail with status code if file does not exist [#75]

wp-cli/language-command

  • Add warning for nonexistent plugins [#115]

wp-cli/media-command

  • Fix read error detection in EXIF discovery [#162]

wp-cli/package-command

  • Adapt test for changed Composer output [#151]

wp-cli/php-cli-tools

  • Fix ${var} string interpolation deprecation [#148]
  • Fix logic to check for TTY [#146]

wp-cli/scaffold-command

  • Deprecate scaffold block in favor of @wordpress/create-block [#311]
  • Add 'testsuite' name in phpunit.xml.dist [#310]
  • Add backup files ending with tilde to default .distignore [#273]

wp-cli/search-replace-command

  • Restore blogdescription to fix test [#171]
  • Add further suppression of warnings and notices [#172]

wp-cli/server-command

  • Restore blogdescription to fix test [#75]

Contributors

@2ndkauboy, @alexstine, @Ayesh, @BhargavBhandari90, @borkweb, @brandonpayton, @connerbw, @dan-m-joh, @danielbachhuber, @dd32, @dlind1, @drzraf, @Flimm, @gedex, @GeoJunkie, @github-actions[bot], @gitlost, @greatislander, @herregroen, @janw-me, @jenkoian, @johnbillion, @jorgeatorres, @jrfnl, @kjohnson, @l3ku, @localheinz, @lucatume, @matzeeable, @michaelzangl, @oandregal, @ocean90, @pbiron, @pdaalder, @pmbaldha, @ponsfrilus, @schlessera, @shendy-a8c, @Sidsector9, @siliconforks, @spacedmonkey, @strarsis, @swissspidy, @Tug, @tyrann0us, @versusbassz, @wojsmol, @xyulex, @yousan

#release, #v2-7-0

WP-CLI v2.6.0 Release Notes

A new release of WP-CLIWP-CLI WP-CLI is the Command Line Interface for WordPress, used to do administrative and development tasks in a programmatic way. The project page is http://wp-cli.org/ https://make.wordpress.org/cli/ is available as of today: WP-CLI v2.6.0. For this release, we had 57 contributors collaborate to get 311 pull requests merged. 🎉

The pandemic is still controlling our daily lives, and as a side-effect we still notice a significant reduction in contributors to WP-CLI, probably due to the lack of in-person contributor days.

As always, big thanks to the WP-CLI sponsors that make the continued maintenance possible – even with a reduced number of contributors. ❤️

Apart from the numerous bug fixes that were included in this release, we also managed to snuggle in a few new features that add to the power or convenience of your CLICLI Command Line Interface. Terminal (Bash) in Mac, Command Prompt in Windows, or WP-CLI for WordPress. experience, so I want to spend a few paragraphs going over some of the noteworthy changes. As always, you can also skip directly to the detailed changelog if you prefer.

PHPPHP PHP (recursive acronym for PHP: Hypertext Preprocessor) is a widely-used open source general-purpose scripting language that is especially suited for web development and can be embedded into HTML. https://www.php.net/manual/en/preface.php. 8.1 Support

WP-CLI now officially supports PHP 8.1. All commands are being extensively tested against PHP 8 and the actual development is currently being done on PHP 8.1 as well.

However, keep in mind that PHP 8.1 support is not fully there for WordPress CoreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress., and especially for a large part of plugins and themes. Due to the nature of the changes that PHP 8.1 brings about, it is very easy to break perfectly compatible WordPress Core or WP-CLI via the actions/filters system. Keep this in mind when trying to diagnose PHP 8.1 compatibility issues and trying to deduce where the erroneous code is to be found.

Tabular data showing a timeline with supported PHP releases, with only 8.0 and 8.1 currently in active support.

For those of you who are not closely following the PHP release cycles, please be aware that only PHP 8.0 and 8.1 are currently actively supported versions. WP-CLI sticks with the WordPress Core PHP support policy (+ 1 year), which means we’re still spending huge amounts of efforts to keep everything running all the way down to PHP 5.6 at the moment.

If you want to help the maintainers in their work, please ensure that all your sites run on the latest PHP versions, and nag your hosting providers to move everything over to the latest and greatest. WordPress will only bump the minimum version when the number of active sites on PHP 5.6 has dropped to an insignificant amount.

New commands for managing application passwords

The following commands were added to allow CLI users to create and manage WordPress application passwords:

  • wp user application-password list
  • wp user application-password get
  • wp user application-password exists
  • wp user application-password update
  • wp user application-password record-usage
  • wp user application-password create
  • wp user application-password delete
WP-CLI examples of creating a new application password and then listing all existing application passwords for that same user.

Although you could technically already work with application passwords by directly controlling the WordPress user-metaMeta Meta is a term that refers to the inside workings of a group. For us, this is the team that works on internal WordPress sites like WordCamp Central and Make WordPress. table, this now provides a clean APIAPI An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways. that abstracts away the technical implementation. See the Application Passwords: Integration Guide to find out more about how to use them.

New global flag: --context

A new global flag --context=<context> was added which allows users to select the WordPress context in which WP-CLI is supposed to execute its command(s).

One of the main goals is to allow WP-CLI to run updates on premium plugins and themes without requiring any special setup. From our initial testing, this allows a large range of popular premium extensions to just work™️ with WP-CLI in terms of their update procedures.

Possible values for this flag with this initial release:

  • cli: The context which has been the default before introduction of this flag. This is something in-between a frontend and an admin request, to get around some of the quirks of WordPress when running on the console.
  • admin: A context that simulates running a command as if it would be executed in the administration backend. This is meant to be used to get around issues with plugins that limit functionality behind an is_admin() check.
  • auto: Switches between cli and admin depending on which command is being used. For this initial release, all wp plugin * and wp theme * commands will use admin, while all other commands will use cli.
  • frontend: [WIP] This does nothing yet.

Roadmap: By default, the --context flag will be set to cli with this initial release (v2.6.0). With WP-CLI v2.7.0, the default will change to auto. This gradual deployment will allow hosters and site owners to run tests on v2.6.0 by manually setting the context before the default behavior is changed.

If you want to use the future default of --context=auto right away in your present operations, you can do so by adding the necessary context: auto line to your global wp-cli.yml configuration file. Feel free to check the documentation on WP-CLI configuration files if this is new to you.

We also have a new hook to support this new global flag: before_registering_contexts. This hook behaves like a filterFilter Filters are one of the two types of Hooks https://codex.wordpress.org/Plugin_API/Hooks. They provide a way for functions to modify data of other functions. They are the counterpart to Actions. Unlike Actions, filters are meant to work in an isolated manner, and should never have side effects such as affecting global variables and output. with one argument: array<string, Context> $contexts. When hooking into this hook, the callback should return (a potentially modified) $contexts value. This can be used to remove or override bundled contexts or add new ones.

To make this work, the hook functionality in WP-CLI (provided via WP_CLI::do_hook()) was modified to return the first argument if arguments were provided.

Thanks to Cloudways for the special support and testing of this new flag with the goal of solving the “premium updates problem” for everyone.

Configurable WP-CLI cache settings

The WP-CLI file cache can now be configured via the following environment variables:

  • WP_CLI_CACHE_DIR – Directory in which to store the cached files. Default value: "$home/.wp-cli/cache".
  • WP_CLI_CACHE_EXPIRY – Time after which cached files are automatically purged, in seconds. Default value: 15552000 (6 months).
  • WP_CLI_CACHE_MAX_SIZE – Total size of the file cache after which older files are purged, in bytes. Default value: 314572800 (300 MB).

This not only allows you to fine-tune the WP-CLI cache behavior for the best balance between available storage and bandwidth usage, it could also be used to share cache storage between installations/users (beware the security implications, though!).

Use custom names/locations for the wp-config.php file

The different config * commands now accept a new flag --config-file=<filepath> that allow you point the different manipulations towards a custom location, that might not even fully adhere to conventions for the WordPress wp-config.php file.

This allows you for example to use the config set command for a configuration file outside of the WordPress document root (and parent folder).

Keep in mind that you’re on your own when it comes to making WordPress understand the structure and bootstrap correctly!

Generate a dotenv file from your existing wp-config.php file

For all the 12-factor app fans out there, WP-CLI has learnt a new format for its config list command: --format=dotenv. This will take the existing configuration key/value pairs in your wp-config.php file and render them in a format that you can use in a .env file.

WP-CLI example of list the contents of the wp-config.php file into a file in dotenv format and then showing the result.

Combine with the previously mentioned --config-file to extract the dotenv file from an arbitrary location, even without a WordPress installation present.

Allow pluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party/theme enumeration without forcing an update check

Previously, when you run plugin list or theme list, WP-CLI would automatically run a check in the background to see if updates are available. This is slow and expensive to do, and might not always be what is needed, especially in scripting scenarios.

This automatic check for updates can now be disabled for these two commands with the --skip-update-check flag. This can drastically speed up some scripts and make them more reliable.

New flag --strict for adapting the filtering of taxonomies by post type

When retrieving taxonomies for a given post type, the old default behavior of WordPress (through the use of get_taxonomies()) is to only show those taxonomies that have as a sole associated post type the requested one. Taxonomies that have multiple associated post types, including the requested one, are not returned.

WordPress had added a newer mechanism via get_object_taxonomies() that would return all taxonomies that are in some way associated with the requested post type, even if other post types are associated as well.

WP-CLI now has a new --strict flag for the taxonomy list command that defines whether the strict filtering (the old default) should be used, or the more sensible inclusive approach should be used via --no-strict (or --strict=false).

We’ve opted to make this new, more sensible approach (i.e. --no-strict) the new default, so be mindful of that if you’re using taxonomy list in a script somewhere.

Another round of improvements to the i18n * commands

As with all of the recent releases, the i18n * commands have received yet another round of overall improvements to keep in sync with the localisation requirements of WordPress Core.

From new flags like --subtract-and-merge, --update-mo-files & --location and multiple improvements to the way JavascriptJavaScript JavaScript or JS is an object-oriented computer programming language commonly used to create interactive effects within web browsers. WordPress makes extensive use of JS for a better user experience. While PHP is executed on the server, JS executes within a user’s browser. https://www.javascript.com/. syntax is parsed all the way up to the support for the new theme.json format, all your localization needs should be accounted for (at least for now).

Make your to check out the detailed logs to find out more and play around with the new functionality when you get the chance!

With super admin permissions come super admin consequences!

WP-CLI now mirrors the behavior of WordPress core and triggers various hooksHooks In WordPress theme and development, hooks are functions that can be applied to an action or a Filter in WordPress. Actions are functions performed when a certain event occurs in WordPress. Filters allow you to modify certain functions. Arguments used to hook both filters and actions look the same. when you grant or revoke the super admin status to users.

The following actions are being triggered now but the super-admin add & super-admin remove commands:

  • grant_super_admin (before changes, always executed)
  • granted_super_admin (after changes, executed only on success)
  • revoke_super_admin (before changes, always executed)
  • revoked_super_admin (after changes, executed only on success)

Changes to the default branches

In order to make the language used in the code and documentation of WP-CLI more inclusive, work has started to change the name of default branch across all repositories. From now on, the default branch name across the WP-CLI GitHubGitHub GitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/ organization is main.

This change is currently a work in progress, as it unfortunately causes open pull requests to be automatically closed and often become unsalvageable. The current progress of this effort can be monitored here: wp-cli/wp-cli#5598.

Keep this in mind when you want to check out the latest development state of a repository or contribute by creating a PR!

Detailed change log

To avoid too much noise in the list above, the following types of pull requests have been omitted:

  • PRs that only bumped dependencies to their latest version.
  • PRs that only fixed a typo in the documentation.
  • PRs that add an allow-plugins rule to Composer

wp-cli/wp-cli-bundle

  • Disable deployments on forks [#389]
  • DeployDeploy Launching code from a local development environment to the production web server, so that it's available to visitors. from main branch [#385]
  • Revert usage of Mustache fork [#373]
  • Use latest branch for Roave security advisories [#357]
  • Add DEB build workflow [#345]
  • Add RPM build workflow [#344]
  • Switch to dev-master for wp-cli framework [#333]

wp-cli/wp-cli

  • Adapt VERSION from 2.5.1-alpha to 2.6.0-alpha [#5605]
  • Fix Composer stack tests [#5599]
  • Detect and ignore BOMs [#5597]
  • Check github.repository_owner in automerge workflow [#5591]
  • Revert addition of the Mustache PHP 8.1 workaround and update dependency [#5590]
  • Use Mustache work-around for PHP 8.1 compat [#5588]
  • Use fork on schlessera for Mustache PHP 8.1 fix [#5587]
  • Re-add subcommands on all composite commands that are overwritten [#5584]
  • Fix default mysqli error reporting mode for PHP 8.1+ [#5582]
  • Add --context flag [#5581]
  • Make cache size and expiry configurable via environment variables [#5576]
  • Updated default branch for roave/security-advisories [#5575]
  • Fix wrong variable name used in argument parsing [#5564]
  • Fix regression that broke extending existing commands [#5563]
  • Add a SECURITY.md file [#5562]
  • Update credits [#5556]
  • Pass in arguments to before_run_command hook [#5554]
  • Change “Fake Site” site name to “WordPress” in core multisite-install command [#5552]
  • Add missing docblocks [#5551]
  • Make logger accessible and add colorization control to Quiet logger [#5549]
  • Fix OOM issues when exporting to STDOUT [#5546]
  • Allow WP_DEBUG_LOG to override the debug.log location [#5511]

wp-cli/handbook

  • Document the exec global parameter [#397]
  • Provide example of optional positional arguments [#390]
  • Added create table statement. [#389]

wp-cli/wp-cli.github.com

  • Update zh-cn translation file [#422]
  • Update build status badge [#416]
  • Fix quick links anchors in German translation [#415]

wp-cli/cache-command

  • Add PHP 8.1 support [#72]

wp-cli/checksum-command

  • Add PHP 8.1 support [#89]

wp-cli/config-command

  • Add PHP 8.1 support [#135]
  • Document special EOF anchor [#136]
  • Add --config-file argument to process custom configuration files [#104]
  • Add dotenv format option to config get command [#102]
  • Escape values to avoid breaking them within single quotes [#95]
  • Update the wp-config.php template [#139]

wp-cli/core-command

  • Update download_package() function signature [#197]
  • Support case-insensitive filesystems when pruning files after update [#196]
  • Do not exit on error but pass on error [#193]

wp-cli/cron-command

  • Add PHP 8.1 support [#77]
  • Adapt feature test to use HTTPSHTTPS HTTPS is an acronym for Hyper Text Transfer Protocol Secure. HTTPS is the secure version of HTTP, the protocol over which data is sent between your browser and the website that you are connected to. The 'S' at the end of HTTPS stands for 'Secure'. It means all communications between your browser and the website are encrypted. This is especially helpful for protecting sensitive data like banking information. with example.com [#78]
  • Promote a non-200 response from the cron spawn test to an error [#66]

wp-cli/db-command

  • Refactor --defaults flag handling [#205]
  • Adapt mysqldump message string to check for in tests [#201]
  • Set 'utf8mb4' when exporting without '--default-character-set' option [#199]
  • Add decimal numbers to wp db size [#163]
  • Add --defaults flag to remaining commands [#206]
  • Add PHP 8.1 support [#214]
  • Fix table existence check in db columns [#210]
  • Adapt feature test to use HTTPS with example.com [#216]
  • Fix “WP_DEBUG already defined” test failure [#220]

wp-cli/embed-command

  • Add PHP 8.1 support [#65]

wp-cli/entity-command

  • Support PHP 8.1 [#331]
  • Update example input to reflect example output [#326]
  • Document default post type filtering for post list command [#321]
  • Correct the home URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org when listing sites [#312]
  • Adapt http => https URLs [#339]
  • Add application password commands [#330]
  • Better error message when trying to delete super admin [#304]
  • Recalculate menu order on insertion or deletion [#275]
  • Add strict/no-strict mode for taxonomyTaxonomy A taxonomy is a way to group things together. In WordPress, some common taxonomies are category, link, tag, or post format. https://codex.wordpress.org/Taxonomies#Default_Taxonomies. list [#256]

wp-cli/eval-command

  • Add PHP 8.1 support [#60]

wp-cli/export-command

  • Ensure post attachment meta is exported correctly [#89]
  • Only add needed user when filtering by --author [#88]
  • Adapt tests [#87]
  • Fix categoryCategory The 'category' taxonomy lets you group posts / content together that share a common bond. Categories are pre-defined and broad ranging., tag and term names missing in export [#86]
  • Add the_title_export filter and cdata for item title to export [#77]
  • Add PHP 8.1 support [#93]
  • Adapt feature test to use HTTPS with example.com [#94]

wp-cli/extension-command

  • Fix test issues [#293]
  • Fix incorrect examples [#290]
  • Check for WP_Error on bulk updates [#294]
  • Add support for PHP 8.1 [#306]
  • Replace one-time-login with a sample plugin in the tests [#302]
  • Add --skip-update-check flag to plugin list and theme list commands [#300]
  • Ensure bundled themes don’t interfere with update tests [#311]

wp-cli/i18n-command

  • Fix tests [#268]
  • Add subtract-and-merge flag [#267]
  • Use more inclusive language in argument description [#266]
  • Add new --update-mo-files flag to make-json [#265]
  • Add new --location flag to omit source code references [#264]
  • Add ext-mbstring to list of suggested dependencies [#263]
  • Prevent adding JS comments to multiple strings [#261]
  • Fix string extraction when using template literals [#260]
  • Update version constraint for mck89/peast [#259]
  • Fix plural extraction in JS [#258]
  • Remove now unneeded workaround in JS scanner [#256]
  • Extract strings for translation from theme.jsonJSON JSON, or JavaScript Object Notation, is a minimal, readable format for structuring data. It is used primarily to transmit data between a server and web application, as an alternative to XML. [#254]
  • Fix string extraction from block.json [#253]
  • Add support to IterableCodeExtractor for symlinks. [#249]
  • Add PHP 8.1 support [#293]
  • Add new field to translate in theme.json [#292]
  • Fix JS string extraction with unsupported argument type [#296]

wp-cli/import-command

  • Add PHP 8.1 support [#71]

wp-cli/language-command

  • Add PHP 8.1 support [#111]

wp-cli/maintenance-mode-command

  • Add PHP 8.1 support [#20]

wp-cli/media-command

  • Add PHP 8.1 support [#153]
  • Add missing intermediate_image_sizes_advanced filter argument for WP 5.3+ [#150]

wp-cli/package-command

  • Only allow secure Composer versions [#144]
  • Support PHP 8.1 [#143]
  • Fetch default branch for GitHub packages [#146]
  • Support common default development branches [#148]

wp-cli/php-cli-tools

  • Update TTY checks [#145]

wp-cli/rewrite-command

  • Add PHP 8.1 support [#54]

wp-cli/role-command

  • Add PHP 8.1 support [#49]

wp-cli/scaffold-command

  • Fix testing on WordPress trunk version [#297]
  • Ignore .github directory in .distignore [#295]
  • Allow for diverging PHPUnit version specifics in tests [#304]
  • Add PHP 8.1 support [#301]

wp-cli/search-replace-command

  • Fix offset handling when doing chunked replacements [#162]
  • Add strict comparisons for color tests [#163]
  • Add PHP 8.1 support [#166]
  • Adapt feature test to use HTTPS with example.com [#167]

wp-cli/server-command

  • Add PHP 8.1 support [#72]

wp-cli/shell-command

  • Add PHP 8.1 support [#58]

wp-cli/super-admin-command

  • Add PHP 8.1 support [#48]
  • Trigger core actions when granting or revoking super-admin permissions [#20]

wp-cli/widget-command

  • Append new widgets to the bottom of a sidebarSidebar A sidebar in WordPress is referred to a widget-ready area used by WordPress themes to display information that is not a part of the main content. It is not always a vertical column on the side. It can be a horizontal rectangle below or above the content area, footer, header, or any where in the theme. [#52]
  • Decouple tests from default theme widgets [#51]
  • Add PHP 8.1 support [#53]

wp-cli/wp-config-transformer

  • Adapt tests for polyfilled test case [#36]

Contributors

@bgturner, @BhargavBhandari90, @CodeProKid, @connerbw, @dd32, @dh-programacion, @dlind1, @drzraf, @felixarntz, @gedex, @gitlost, @grappler, @greatislander, @herregroen, @imadphp, @janw-me, @jenkoian, @jmdodd, @johnbillion, @johnjago, @jrfnl, @kapilpaul, @KarlAustin, @l3ku, @localheinz, @matzeeable, @mbuxsoomro, @michaelzangl, @mircobabini, @mn7zDev, @mrkaluzny, @nickdaugherty, @Nikschavan, @oandregal, @ocean90, @pbiron, @pdaalder, @petruchek, @pmbaldha, @ponsfrilus, @ryotsun, @saz, @schlessera, @seatonjiang, @siliconforks, @skeltoac, @stefanpejcic, @stodorovic, @swissspidy, @tammelin, @thomasplevy, @Tug, @tyrann0us, @UVLabs, @wojsmol, @wpamitkumar, @yousan

#release, #v2-6-0

New Premier Sponsor added: Cloudways

Cloudways Logo

A new premier sponsor has come forward and is added to the list of generous companies that sponsor the WP-CLIWP-CLI WP-CLI is the Command Line Interface for WordPress, used to do administrative and development tasks in a programmatic way. The project page is http://wp-cli.org/ https://make.wordpress.org/cli/ project: Cloudways!

Please help me in welcoming this new sponsor, as well as say thanks to all the other currently active sponsors:

There’s also a new page on the site now where you can see the full list of currently active sponsors at all times: https://make.wordpress.org/cli/sponsors/.

#sponsorship