DocsWP — WordPress Help

WP-CLI v2.7.0 Release Notes

A new release of WP-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 extensible via a clean API, 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 filter 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 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 Core 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 HTTP 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 URL.

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 meta 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 plugin 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 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 MySQL 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 JSON 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