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. http://php.net/manual/en/intro-whatis.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 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

WP-CLI v2.5.0 Release Notes

Here it finally is, the long-awaited 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/ release v2.5.0! For this release, we had 73 contributors collaborate to get a whopping 600 pull requests merged.

It was a very tough release to get out, as so many different systems and dependencies all broke or had issues at the same time: 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. http://php.net/manual/en/intro-whatis.php., 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/., Travis CI, Composer, Requests, … all of these produced major compatibility issues in a seemingly concerted effort! 😅

More importantly, though, I’m pretty certain that all of the WP-CLI contributors were additionally suffering under the “new normal” of COVID-19 – those contributors lucky enough to still earn regular income during the pandemic are still battling health issues (for themselves and their family), isolation and burnout.

As a maintainer, my initial plan was to devise special events and additional incentives to hopefully raise the level of contribution back up again. But I decided against doing so. Even though we all can’t wait to get a new release out and onto servers, I did not want to add to the additional pressure that the volunteer contributors are already feeling right now. The risks of burnout or other negative effects on mental health have never been so prevalent than now where everyone has to dial down their social support systems. In that perspective, I opted to knowingly go with a longer release time. I am fully aware that a lot of companies had to look into extra workarounds or similar to deal with the late release, but I had to assume that this still happens in a paid capacity. Given the global situation, this seemed more justifiable to me than moving the cost towards volunteer health instead.

Thanks to all the support I had during the extended release time, not least to the WP-CLI sponsors who have allowed me to personally invest as much time as needed into the project to make this release happen.

Now, with that being said, let’s go over some of the noteworthy changes in this release. As always, you can also skip directly to the detailed changelog if you prefer.

Security Fixes

This release fixes one direct and one upstream security vulnerability, so it is recommended for everyone to update to this latest release.

Improper Certificate Validation in WP-CLI framework

This security vulnerability is categorized as CWE-295: Improper Certificate Validation with a CSSCSS CSS is an acronym for cascading style sheets. This is what controls the design or look and feel of a site. V3 severity rating of ‘high‘ and was disclosed as CVE-2021-29504 (GitHubGitHub GitHub is a website that offers online implementation of git repositories that can 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/ security advisory GHSA-rwgm-f83r-v3qj).

An improper error handling in 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. requests management in WP-CLI version 0.12.0 and later allows remote attackers able to intercept the communication to remotely disable the certificate verification on WP-CLI side, gaining full control over the communication content, including the ability to impersonate update servers and push malicious updates towards WordPress instances controlled by the vulnerable WP-CLI agent, or push malicious updates toward WP-CLI itself.

The vulnerability stems from the fact that the default behavior of WP_CLI\Utils\http_request() when encountering a TLS handshake error is to disable certificate validation and retry the same request.

The default behavior has been changed with version 2.5.0 of WP-CLI and the wp-cli/wp-cli framework (via wp-cli/wp-cli#5523) so that the WP_CLI\Utils\http_request() method accepts an $insecure option that is false by default and consequently that a TLS handshake failure is a hard error by default. This new default is a breaking change and ripples through to all consumers of WP_CLI\Utils\http_request(), including those in separate WP-CLI bundled or third-party packages.

Insecure Deserialization of untrusted data in upstream Requests library

This security vulnerability is categorized as CWE-502: Deserialization of Untrusted Data with a CSS V3 severity rating of ‘critical‘ and was disclosed as CVE-2021-29476.

The vulnerability was found in the FilteredIterator class and was first reported to the WordPress project. The security fix applied to WordPress has been ported back into the Requests library and was distributed with release v1.8.0.

Breaking Changes

The security fix for CVE-2021-29504 detailed above led to a breaking change where the retry behavior of commands that use remote requests is disabled. Furthermore, the framework is stricter in making use of the certificates that are provided via environment settings.

This means that automated systems that previously succeeded with reliable downloads of external assets can now start to fail because there is an issue with the certificate verification. This can be due to either the environment being misconfigured for certificate verification or the server to connect to actually being insecure.

To get back to the previous behavior, the affected commands now include a new --insecure flag that re-enables the insecure retrying mechanism again. Beware: This opens up these remote requests to man-in-the-middle attacks!

The following commands were affected and were adapted to recognize this new --insecure flag:

  • cli update
  • config create
  • config shuffle-salts
  • core download
  • core update
  • core verify-checksums
  • package install
  • plugin install
  • plugin update
  • plugin verify-checksums
  • theme install
  • theme update

PHP 8 support

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

However, keep in mind that PHP 8 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 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 compatibility issues and trying to deduce where the erroneous code is to be found.

Improved MySQL/MariaDB support

As it turns out, WordPress Core has not been compatible with a default MySQL database for a while now. What actually happens is that WordPress switches the database in a sort of “legacy” mode at runtime. This has caused the WP-CLI code that uses WPDB to slowly diverge in results from the code that makes direct database requests via the mysql shell binary.

This has now been rectified (at least for all of the major use cases) by letting WP-CLI employ the same “legacy” database mode via a few hacks around the mysql binary.

Package Manager is now powered by Composer v2

Composer v2 has drastically improved both the processing time as well as the memory usage of its dependency resolution mechanisms. And now the WP-CLI Package Manager that you can use via wp package * commands gets to benefit from these same improvements, at it internally uses the new Composer v2 code.

This should also make the dreaded Out-Of-Memory problems with package installation much rarer, even on shared hosting or tight Docker containers.

New commands for managing automatic updates

The following commands were added to allow you to manage the state of automatic updates for plugins and themes:

  • plugin auto-updates disable
  • plugin auto-updates enable
  • plugin auto-updates status
  • theme auto-updates disable
  • theme auto-updates enable
  • theme auto-updates status

Although you could technically already work on the state of the automatic updates by directly controlling the WordPress Options 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.

New command for creating MO files

A new command was added to the wp-cli/i18-command package for creating MO files from existing PO files. This can be useful if you use a translation platform that can only output PO files, or tooling that modifies these files.

// Reads from a single .po file.
$ wp i18n make-mo ./wp-content/languages/slug.po
Success: Created 1 file.

// Reads from a directory for multiple .po files.
$ wp i18n make-mo ./wp-content/languages/
Success: Created 5 files.

Smarter I18N handling of JS files

The ongoing effort to improve the internationalization of client-side 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/. code that is made necessary by the move to the blockBlock Block is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage using the WordPress editor. The idea combines concepts of what in the past may have achieved with shortcodes, custom HTML, and embed discovery into a single consistent API and user experience.-based editor has led to a number of improvements to the i18n make-pot command.

Apart from understanding more complex Javascript constructs, like webpack bundling and JS eval() statements, the i18n make-pot now also parses the new block.json file as it is defined in the Block Type Registration RFC. This can optionally be skipped via the new --skip-block-json flag.

New environment variable: WP_CLI_ALLOW_ROOT

When you’ve been using WP-CLI within a Docker container, you’ve probably noticed the big “YIKES!” message you get that aborts the execution of the command if it detects that you’re running as root. You’d then have to add the --allow-root flag to every single command you run within that container.

Within a docker container, everything is done as the root user, though, and there’s no really security issue, as the container itself acts as a sandbox. Therefore, WP-CLI now allows you to let it know not to warn about the root user via the new WP_CLI_ALLOW_ROOT environment variable. Just set this variable through in your container’s ENV section, and you’re good to go – no need for multiple --allow-root flags anymore.

New global parameter: --exec

Some scenarios require you to run a small PHP snippet before the actual WP-CLI command, to make sure the command runs under the right context or encounters the right environment. You would typically do this by creating a PHP file with the code snippet that needs to be executed and then using the --require global parameter to load that file upfront before the command gets executed.

This is very cumbersome for short snippets, though, or not even easily possible on read-only filesystems. Therefore, WP-CLI now also accepts a new global parameter --exec that you can use to execute PHP logic directly from the command-line before running the actual command.

$ wp --exec='define( "WP_ADMIN", true );' plugin update --all

Support for third-party WP-CLI packages on GitLab

The WP-CLI package manager now supports GitLab URLs. This means you can host your custom commands on GitLab and still easily install them right from the VCS:

$ wp package install https://gitlab.com/my/package.git

Chunked queries in search-replace to avoid memory issues

When you need to run a search & replace operation on a very large database, you can easily run into memory issues. WP-CLI tried to fetch all matching query results into memory to loopLoop The Loop is PHP code used by WordPress to display posts. Using The Loop, WordPress processes each post to be displayed on the current page, and formats it according to how it matches specified criteria within The Loop tags. Any HTML or PHP code in the Loop will be processed on each post. https://codex.wordpress.org/The_Loop. over them.

This type of operation is now processed via a chunked loop that works on 1000 query results at a time via pagination. This drastically reduces the memory requirements and decouples them from the database size.

This is just the first command that receives this treatment, but expect to see more of such scalability fixes in the future.

Hide global parameters help

If you’re a more seasoned WP-CLI, you might have been annoyed from time to time about the wasted screen real estate on the help screens that always append the list of global parameters every single time.

You can now choose to skip the display of these global parameters by setting the following environment variable:

export WP_CLI_SUPPRESS_GLOBAL_PARAMS=true

All the help screens will then only display the help for the current context.

Switch from Travis CI to GitHub Actions

For multiple different reasons, I decided to move away from Travis CI, and I ended up migrating the entire infrastructure (testing, automation, deployment, publication, …) over to GitHub Actions.

You will now find a .github/workflows folder in each of the repositories that contains a set of workflows for that repository. However, we also have a new wp-cli/.github repository. This contains centralized workflows that mostly deal with keeping the workflows and configurations across all of the other repositories in sync.

This means that, when I now need to make a change in the testing workflow, for example, I don’t need to manually create a pull request in each of the packages. I modify the template workflow in the wp-cli/.github repository instead, and this one then syncs all the changes over to the individual repositories.

The added automation details, as well as the much improved parallelization of running the tests in GitHub Actions has drastically accelerated the development experience and ultimately leads to faster and cheaper maintenance of the entire project.

Documentation is automatically kept in sync

If you’ve contributed to one of the commands before, I might have required you to install the wp-cli/scaffold-package-command package and run a cryptic command on your PR to get the README.md file updated based on changes in the code’s docblocks. This was an awful contributor experience and I wanted to get rid of that requirement.

When I initially experimented with a git hook to automatically add a commit on PRs when they are pushed, I realized that that approach leads down to a path of merge conflicts and confusion.

The move from Travis CI to GitHub Actions was a good opportunity to revisit this, as I have now solved this problem via an automated GitHub Actions workflow. Whenever changes are pushed to the default branch of a repository, the GitHub Actions bot will try to regenerate the documentation and if this actually produced any changes, it creates a new pull request with the needed patch.

This PR can then be reviewed and merged just like any other contribution. It happens independently of the code change a contributor submitted, so they don’t need to worry about any of this.

MigrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. to Behat v3

WP-CLI has been stuck with Behat v2 for quite a while now, and this also had an impact on the dependencies we needed to rely on. This made the move to PHP 8 compatibility all the more difficult. Therefore wp-cli/wp-cli-tests was updated to migrate from Behat v2 to Behat v3.

Apart from multiple improvements of the syntax and its execution, this also finally makes it easy to reuse the functional testing infrastructure outside of a wp-cli package. Expect to see a guide on how to migrate your own package code to Behat v3 as well as on how to use wp-cli/wp-cli-tests within other contexts soon.

More flexible test setup

The test setup was made way more configurable to adapt to less standardized environments. Where it was previously difficult to run the tests on a non-traditional stack like a Docker network or a GitHub Actions environment, this can now be easily done via a set of new environment variables.

The database credentials can now be provided via the following environment variables:

WP_CLI_TEST_DBHOST host to use and can include a port, i.e “127.0.0.1:33060”localhost
WP_CLI_TEST_DBROOTUSER user that has permission to administer databases and usersroot
WP_CLI_TEST_DBROOTPASS password to use for the above user(empty password)
WP_CLI_TEST_DBUSER user that the tests run underwp_cli_test
WP_CLI_TEST_DBPASS password to use for the above userpassword1

Provided that these environment variables are present and that your database is online, a simple composer prepare-tests will take care of everything.

Detailed change log

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

  • PRs that dealt with Travis CI and its many issues, as Travis CI has now been replaced with GitHub Actions. Note that the PRs that switched from Travis CI to GitHub Actions are still included, as these often include fixes in the tests or even in the actual code to make the tests pass again on GHA.
  • PRs that only bumped a single dependency to its latest version.
  • PRs that only fixed a typo in the documentation.

wp-cli/wp-cli-bundle

  • Fix typo in Symfony autoloader strips [#323]
  • Adapt Phar build [#322]
  • Remove myclabs/deep-copy from Phar [#321]
  • Optimize build [#320]
  • Flip Symfony dependency management logic [#315]
  • Keep symfony/polyfill-intl-normalizer in Phar [#314]
  • Keep symfony/deprecation-contracts in Phar [#313]
  • Keep symfony/polyfill-php80 in Phar [#312]
  • Add regression test for using magic constants in wp-config.php [#309]
  • Add PHP 8 back as testing requirement [#276]
  • Adapt reading of version artifact [#275]
  • Persist version as GHA artifact [#274]
  • Update deployment workflow [#273]
  • Update GHA functional tests workflow [#267]
  • Handle files with the .php8 extension [#263]
  • Remove symfony/polyfill-php80 [#261]
  • Conditionally include react folder in phar [#259]
  • Switch from Travis CI to GitHub Actions [#249]
  • Updated minimum required PHP version to 5.6 [#198]
  • Bump PHPCSPHP Code Sniffer PHP Code Sniffer, a popular tool for analyzing code quality. The WordPress Coding Standards rely on PHPCS. compatibility tests to new PHP 5.6+ minimum [#197]

wp-cli/wp-cli

  • Require v1.8 of Requests [#5529]
  • Remove tech debt via Rector [#5528]
  • Move fetcher implementations back into framework [#5527]
  • Add WpOrgApi abstraction to handle WordPress.orgWordPress.org The community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/ API requests [#5526]
  • [BREAKING CHANGE] Disable automatic retry by default on certificate validation error [#5523]
  • Add missing $pipes variables when creating processes [#5522]
  • Harden error message on failed cache directory creation [#5520]
  • Update docblocks for methods that accept error objects [#5516]
  • [BREAKING CHANGE] Use custom certificate if provided [#5514]
  • [BREAKING CHANGE] Respect provided verify option in Utils\http_request [#5507]
  • Add magic properties to docblock [#5504]
  • Allow disabling of ini_set() [#5499]
  • Update GHA functional tests workflow [#5498]
  • Switch from Travis CI to GitHub Actions [#5483]
  • Add PHP 8 as an allowed PHP version [#5477]
  • Fix registering a command with a class and method name pair on PHP 8 [#5476]
  • Add $properties argument to __set_state magic() method [#5469]
  • Improve regex to match __FILE__ and __DIR__ magic constants [#5465]
  • Skip using removed Operation::getReason() for Composer v2 compat [#5462]
  • Support custom folder structures in wp-config.php file [#5460]
  • Fix wrong argument type in proc_open_compat() [#5459]
  • Fix non static methods in Extractor_Test class call statically [#5457]
  • Only suppress global parameters if set as true [#5455]
  • Add global parameter --exec for executing PHP [#5454]
  • Missing @return tag in function/method PHPDoc comment [#5450]
  • Allow root from environment via WP_CLI_ALLOW_ROOT environment variable [#5448]
  • Fix a broken link in the README.md file [#5443]
  • Add support for Redis Object Cache [#5436]
  • Allow user to suppress global parameters info from help display [#5423]
  • Updated license date [#5421]
  • Add $interactive arg for run_mysql_command() [#5420]
  • Add support for comma-separated flag values [#5419]
  • Fix SERVER_PORT 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. encoding failure [#5417]
  • Create a default global config file if it does not exist [#5411]
  • Updated minimum required PHP version to 5.6 [#5408]
  • Include classmap in order to fix Composer 2 deprecation notices [#5407]
  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#5406]
  • Throw exception when misusing error_to_string() [#5405]
  • Add regenerate-readme GitHub Action workflow [#5399]
  • Improve replace_path_costs() with logic from eval file command [#5397]
  • Add database info to cli info command [#5386]
  • Let Utils\run_mysql_command() return data [#5384]
  • [BREAKING CHANGE] Remove is_bundled_command() method [#5375]
  • Allow for array of strings in ComposerIO [#5370]
  • Escape path before wp-config.php string replacement [#5368]
  • Add $wp_config_path param for get_wp_config_code() [#5366]
  • Update drush project URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org [#5350]
  • Support exceptions in WP_CLI::error_to_string() method [#5331]
  • Show full command after using the --prompt flag [#5322]

wp-cli/handbook

  • Update handbook for v2.5.0 release [#381]
  • Add altushost.com to hosting-companies.md [#380]
  • Add hostico.ro to hosting-companies.md [#379]
  • “1&1” is now called “IONOS” [#376]
  • Update link to tutorial [#375]
  • Update running-commands-remotely.md [#374]
  • Add WP Provider to hosting-companies.md [#373]
  • Add dhosting.pl to hosting-companies.md [#371]
  • Adding Veerotech to hosting-companies.md [#368]
  • Add Oderland to hosting-companies.md [#367]
  • Add info for WP_CLI_SUPPRESS_GLOBAL_PARAMS env variable [#365]
  • Update link on the index page [#364]
  • Add ManagedWPHosting to hosting-companies.md [#363]
  • Update expression for dependencies of PHPUnit [#362]
  • Create a new “How to …” section in the handbook [#360]
  • Update Handbook frontpage [#359]
  • Add a link in the Option Update page of the Handbook to the Option Reference page in the Codex [#358]
  • Update plugin-unit-tests.md with more details [#357]
  • Add SpinupWP to hosting-companies.md [#355]
  • Add Zenith Media Canada to hosting-companies.md [#348]
  • Update global configuration parameters URL. [#347]
  • Add 20i to hosting-companies.md [#344]
  • Add WooCart to hosting-companies.md [#336]

wp-cli/wp-cli.github.com

  • Update Romanian translation [#407]
  • Fix broken markup in German translation [#405]
  • Add initial right-to-left support [#403]
  • Update German translation to match the English version [#402]
  • Update Chinese Simplified translation [#400]
  • Add Chinese Simplified support [#398]

wp-cli/cache-command

  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#65]
  • Switch from Travis CI to GitHub Actions [#66]
  • Update GHA functional tests workflow [#69]

wp-cli/checksum-command

  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#73]
  • Switch from Travis CI to GitHub Actions [#78]
  • Prevent unnecessary directory recursion [#77]
  • Update GHA functional tests workflow [#80]
  • Add --insecure flag to core|plugin verify-checksums commands [#86]

wp-cli/config-command

  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#110]
  • Allow for shuffling of specific keys and generating new ones [#114]
  • Update documentation link [#111]
  • Switch from Travis CI to GitHub Actions [#116]
  • Update GHA functional tests workflow [#123]
  • Add --insecure flag to config create & config shuffle-salts commands [#128]

wp-cli/core-command

  • Fix DB Upgrade tests for PHP 7.4 [#162]
  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#159]
  • Remove command substitution from is-installed example [#145]
  • Change CoreUpgrader::download_package signature [#166]
  • Switch from Travis CI to GitHub Actions [#175]
  • Update GHA functional tests workflow [#181]
  • Add --insecure flag to core download & core update commands [#186]

wp-cli/cron-command

  • Add command to unschedule all events with a given hook [#51]
  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#67]
  • Fix documentation for the cron delete command. [#62]
  • Switch from Travis CI to GitHub Actions [#69]
  • Update GHA functional tests workflow [#72]

wp-cli/db-command

  • Add --defaults flag to allow loading of MySQL configuration [#157]
  • Emulate WordPress SQL mode compat hack [#169]
  • Add SQL mode compat query to db import command [#170]
  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#172]
  • Use MySQL binary in interactive mode for db cli command [#178]
  • Switch to GitHub Actions [#182]
  • Update GHA functional tests workflow [#188]
  • Extend wp db export description [#184]
  • Document that individual text columns are searched. [#174]

wp-cli/embed-command

  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#56]
  • Fix Behat tests [#57]
  • Switch from Travis CI to GitHub Actions [#58]
  • Update GHA functional tests workflow [#60]

wp-cli/entity-command

  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#295]
  • Update site empty feature to handle sticky posts [#290]
  • Update site empty command to include removal of wp_links table data [#284]
  • Fix comment approval test [#299]
  • Switch from Travis CI to GitHub Actions [#305]
  • Update GHA functional tests workflow [#310]
  • Remove Fetcher implementations [#320]
  • Add workflow for regenerating README.md file [#316]

wp-cli/eval-command

  • Improve __FILE__/__DIR__ regex pattern [#44]
  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#48]
  • Switch from Travis CI to GitHub Actions [#51]
  • Update GHA functional tests workflow [#54]
  • Reuse Utils\replace_path_consts() for magic constants [#59]

wp-cli/export-command

  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#70]
  • Switch from Travis CI to GitHub Actions [#73]
  • Add post_modified and post_modified_gmt fields to export [#75]
  • Update GHA functional tests workflow [#79]
  • Improve type handling and remove unused variables [#84]

wp-cli/extension-command

  • Prevent array access notice when $update_info is null [#214]
  • Add missing --network parameter for plugin is-active [#222]
  • Don’t show a warning when theme delete --all skips the active theme [#218]
  • Deny --dry-run usage when requiring a specific version [#236]
  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#235]
  • Allow for filtering multiple field values for the list command [#234]
  • Validate the --status 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. passed to wp plugin list and wp theme list [#229]
  • Add commands to manage auto-updates for plugins and themes [#259]
  • Provide clear error message when 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 fails PHP requirement [#253]
  • Only run auto-updates commands on WP 5.5+ [#269]
  • Avoid notice when $update_info is null [#265]
  • Switch from Travis CI to GitHub Actions [#273]
  • Update GHA functional tests workflow [#279]
  • Add --insecure flag to plugin|theme install & plugin\theme update commands [#287]

wp-cli/i18n-command

  • Ensure that the pot file use the same license as the plugin [#199]
  • Add wp i18n make-mo command. [#214]
  • block.json string extraction [#210]
  • Add option --skip-php to i18n make-pot command [#207]
  • Parse mangled Webpack statements [#204]
  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#215]
  • Scan for esc_xml_*() localization helpers [#221]
  • Switch from Travis CI to GitHub Actions [#235]
  • Update GHA functional tests workflow [#241]
  • Add support for indirect translation function calls in JS [#228]
  • Extract strings contained within eval() [#222]

wp-cli/import-command

  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#60]
  • Switch from Travis CI to GitHub Actions [#61]
  • Update GHA functional tests workflow [#63]
  • Fix menu import tests [#69]

wp-cli/language-command

  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#95]
  • add $hook_extra to LanguagePackUpgrader::download_package() [#100]
  • Switch from Travis CI to GitHub Actions [#104]
  • Update GHA functional tests workflow [#106]

wp-cli/maintenance-mode-command

  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#9]
  • Switch from Travis CI to GitHub Actions [#11]
  • Update GHA functional tests workflow [#13]

wp-cli/media-command

  • Skip video cover regeneration on WP 5.5+ [#129]
  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#132]
  • Update GHA functional tests workflow [#140]

wp-cli/package-command

  • Update URL to “Commands cookbook” documentation [#115]
  • Replace missing test package [#113]
  • Fix broken tests because of missing repo [#112]
  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#121]
  • Support gitlab.com URLs [#117]
  • Make the package manager compatible with Composer v2 [#127]
  • Switch from Travis CI to GitHub Actions [#128]
  • Update GHA functional tests workflow [#130]
  • Add --insecure flag to package install command [#138]
  • Improve installation instructions [#136]
  • Remove duplicate test and mark remaining as broken [#140]

wp-cli/php-cli-tools

  • Fix deprecated usage of join() [#142]

wp-cli/rewrite-command

  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#44]
  • Switch from Travis CI to GitHub Actions [#47]
  • Update GHA functional tests workflow [#49]

wp-cli/role-command

  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#40]
  • Switch from Travis CI to GitHub Actions [#41]
  • Update GHA functional tests workflow [#43]

wp-cli/scaffold-command

  • Include --ignore-externals when running svn co [#243]
  • Update plugin/theme test scaffolding [#262]
  • Use longer option names in install_db() to avoid stalling CIs [#255]
  • Deal with existing database in test init script [#249]
  • GitHub workflow files should be ignored on build [#270]
  • Make use of $EXTRA connection settings in install_db() [#269]
  • WP_CORE_DIR does not need a trailing slash [#266]
  • Updated minimum required PHP version to 5.6 [#265]
  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#264]
  • Scaffold block support 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/. [#242]
  • Keep test suite in sync with WP files when testing trunk/nightlies [#271]
  • Fix PHPCS issues for post-types [#276]
  • Add a callback for the bulk messages for post-types [#275]
  • Fix variables in tests [#284]
  • Add missing clean-up in templates/install-wp-tests.sh [#283]
  • Add updated GHA testing workflow [#282]

wp-cli/search-replace-command

  • Improve error message on regex check [#131]
  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#141]
  • Only try to unserialize strings [#148]
  • Switch from Travis CI to GitHub Actions [#152]
  • Chunk query that can potentially OOM [#153]
  • Update GHA functional tests workflow [#156]

wp-cli/server-command

  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#64]
  • Switch from Travis CI to GitHub Actions [#65]
  • Update GHA functional tests workflow [#67]

wp-cli/shell-command

  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#48]
  • Fixed PsySH initialization [#49]
  • Switch from Travis CI to GitHub Actions [#51]
  • Update GHA functional tests workflow [#54]

wp-cli/super-admin-command

  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#41]
  • Switch from Travis CI to GitHub Actions [#42]
  • Update GHA functional tests workflow [#44]

wp-cli/widget-command

  • Bump PHPCS compatibility tests to new PHP 5.6+ minimum [#42]
  • Switch from Travis CI to GitHub Actions [#44]
  • Update GHA functional tests workflow [#46]

wp-cli/wp-config-transformer

  • Update Composer requirement to include v2 [#29]

Contributors

@2ndkauboy, @aaemnnosttv, @aidvu, @akkspros, @alexholt, @ankitpanchal7, @austinginder, @chesio, @ChrisWiegman, @claudiosanches, @connerbw, @danielbachhuber, @dd32, @dilipbheda, @dishitpala, @drzraf, @dsifford, @ediamin, @emersonveenstra, @freezy-sk, @gedex, @gitlost, @greatislander, @herregroen, @iandunn, @janw-me, @jasongill, @jenkoian, @jespervnielsen, @jmdodd, @joemcgill, @johnbillion, @jrfnl, @kadimi, @l3ku, @Lewiscowles1986, @localheinz, @matzeeable, @michaelzangl, @msaggiorato, @mukeshpanchal27, @ocean90, @octalmage, @oytuntez, @pbiron, @pdaalder, @pmbaldha, @ponsfrilus, @rob006, @schlessera, @shahariaazam, @siliconforks, @stevegrunwell, @swissspidy, @szepeviktor, @tedsecretsource, @thrijith, @tillkruss, @TimothyBJacobs, @torounit, @tosite, @Tug, @uplime, @vaishaliagola27, @vsamoletov, @waclawjacek, @WhiteWinterWolf, @wojsmol, @wpamitkumar, @yousan, @yukihiko-shinoda, @zaantar, @zzap

#release, #v2-5-0

WP-CLI v2.5.0 release date

The long-awaited release v2.5.0 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 19th, 2021.

I won’t go into too much detail about why the release was so long in the making, but let me nevertheless add a link to an article in which Juliette Reinders Folmer eloquently talks about some of the reasons: https://24daysindecember.net/2020/12/21/a-perfect-storm/. Add to this the fact that the pandemic situation has drastically reduced the pool of contributors, as well as Travis CI deciding to effectively drop OSS support (forcing me to switch both testing and deployments to GitHubGitHub GitHub is a website that offers online implementation of git repositories that can 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/ Actions), and we’re in a situation that I’m glad will finally be resolved again soon.

Thanks to all the sponsors of the project that make it possible to work on WP-CLI with the persistence and staying power it requires.

Also big thanks to the contributors to the project that kept helping me figure out bugs and come up with solutions! I truly appreciate all your assistance.

And in case you’re one of the many people who created an issue in recent times that hasn’t been resolved yet, know that getting v2.5.0 out was an absolute priority, but I’ll slowly work off the backlog again once the pressing compatibility issues have been taken care of.

#release, #v2-5-0

WP-CLI Release v2.4.0

Just in time for the release of WordPress CoreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. 5.3.0 we have 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/ as well. A team of 37 contributors has collaborated to get 159 pull requests merged.

Let’s go over some of the noteworthy changes in this release. Most of the work went into compatibility fixes, so there’s not many new toys to play around with, unfortunately. As always, you can also skip directly to the detailed changelog if you prefer.

WordPress 5.3 support

It should be obvious that WP-CLI supports the latest upcoming WordPress Core release, of course. However, there were quite a few changes that went into 5.3 that made it not only difficult to keep WP-CLI working across 5.3 and earlier versions at the same time, but also made it necessary to release WP-CLI in parallel to have a working option available.

The push to support more of the newer 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. http://php.net/manual/en/intro-whatis.php. features that became available due to the bump to the minimum PHP version of Core introduced changes to function signatures and class interfaces, which required a few adventurous fixes in some cases…

PHP 7.4 support

PHP 7.4 is not yet available in a stable release, but we’re slowly coming closer to the planned release date.

There have been quite a few fixes that went into WP-CLI to make sure it works correctly with PHP 7.4 once it’s available. It’s an ongoing process, still, as we’re working towards the first stable version. Tests are running for PHP 7.4 in the background as well for each package. These are still allowed to fail right now, but after this release, they will be switch to break on error.

Download a specific URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org as Core

The core download command now accepts a URL to download a specific ZIP archive with a version of Core to use. This also allows you to use your own custom version easily. Just add the URL and you’re good to go: wp core download https://somesite/build.zip

Large image support

WP-CLI will properly deal with large images in the way that WP Core 5.3 was improved. It knows about the original source images as well so you can safely rebuild your thumbnails without losing quality.

Detailed Change Log

wp-cli/wp-cli-bundle

  • Allow patches from dependencies to be applied [#150]

wp-cli/handbook

  • Fix STDERR redirection example code [#342]
  • Add SiteDistrict to hosting-companies.md file [#341]
  • Update reference URLs. [#337]
  • Add WooCart to hosting-companies.md file [#336]
  • Add MinHost to hosting-companies.md file [#334]

wp-cli/wp-cli.github.com

  • Update romanian translation [#392]
  • Update link to wp-completion.bash [#391]
  • [pt_BR] Update to v2.3.0 + refresh sponsors [#390]
  • Update Turkish translation [#389]
  • Small adjustments for French translation [#388]
  • Update ja/index.md [#387]

wp-cli/core-command

  • Use version known to work for core download test [#136]
  • Support URL for core download [#135]
  • install changed to installation [#132]
  • 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.-convert, don’t assume site_id is 1 [#122]

wp-cli/db-command

  • Fix tests for changes in WP Core 5.3 [#149]
  • Make db clean get all the tables with prefix [#152]
  • Fix output message for STDIN input [#151]

wp-cli/entity-command

wp-cli/extension-command

  • Add second must-use 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 that is added with wp-cli-tests 2.1.6+ [#200]
  • Equalize theme folder naming conventions across Win/Mac/Linux [#196]

wp-cli/i18n-command

  • Adapt code to gettext v4.8 [#194]
  • Add --debug output for the file being processed. [#183]
  • Use correct argument name in warning message [#180]

wp-cli/media-command

  • Adapt to changes in WP 5.3 image handling to fix broken tests [#115]
  • Fix suffix of scaled large images [#118]

wp-cli/scaffold-command

  • Required PHP version 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. [#238]
  • Fix deprecated whitelist code flag [#236]
  • Switch test prep feature from global PHPUnit to local PHPUnit [#235]
  • Add a minimum php requirement [#234]
  • Scripts added to plugin package.json [#225]

wp-cli/widget-command

  • Adapt tests to make the widgetWidget A WordPress Widget is a small block that performs a specific function. You can add these widgets in sidebars also known as widget-ready areas on your web page. WordPress widgets were originally created to provide a simple and easy-to-use way of giving design and structure control of the WordPress theme to the user. expectations more flexible [#34]

Contributors

@aommundsen, @azito122, @beaucollins, @burhandodhy, @connerbw, @derweili, @drzraf, @dz0ny, @felipeelia, @gitlost, @greatislander, @herregroen, @jrfnl, @l3ku, @localheinz, @marksabbath, @marty-crane, @maximejobin, @mcdwayne, @michaelzangl, @mustafauysal, @nxnjz, @nylen, @ocean90, @pdaalder, @raphael-concil, @sagarnasit, @schlessera, @siliconforks, @swissspidy, @tecking, @thrijith, @vladutilie, @wojsmol, @yousan, @zzap

#release, #v2-4-0

WP-CLI Release v2.3.0

This release v2.3.0 is, as already announced, rather unspectacular. The previous release was very taxing for several reasons, so we lowered the pace for a while to recover.

This version is mainly meant to finally get a few bug fixes out there that were not critical enough to warrant an immediate hotfix release but are nice to have eradicated at one point, nevertheless.

Overall, a team of 36 contributors has collaborated to get 129 pull requests merged. I’ll briefly go over some of the more noteworthy stuff, but as always, you can also skip directly to the detailed changelog if you prefer.

New command to fix image orientation

Some cameras and smartphones will automatically tag pictures to denote “which way is up”. This means that you will have these devices show you the pictures you took during your handstand in the correct orientation no matter what, even though the actual picture file is upside down.

The media command now has a new subcommand media fix-orientation that reads these special tags and properly applies them to your images. This way, the images will also be shown with the correct orientation on devices that do not support this tag.

You can now skip tables using wildcards

The --skip-tables flag for the search-replace command has learnt a new trick – it now lets you skip a group of tables in one go through wildcards.

You can use wildcards like 'wp_*options' or 'wp_post*' to make your life easier.

Add config settings to the end of the file

Up until now you always had to provide an anchor to attach changes to your wp-config.php to when using the config add command.

You can use this through the special anchor flag --anchor=EOF.

Optimized vagrant support

When you’re connecting to your vagrant VMs through 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/’s special-case vagrant SSHSSH Secure SHell - a protocol for securely connecting to a remote system in addition to or in place of a password. connection scheme, you’ll notice that the operations are way faster now, as we’re caching the configuration across calls now.

Detailed Change Log

wp-cli/wp-cli-bundle

  • Permit use of php7.2-mysql and php7.3-mysql in Debian build [#130]

wp-cli/wp-cli

  • Make extraction more robust [#5261]
  • Improve “Adding deferred command…” debug output (Closes: #4893) [#5242]
  • Fix parse_url scheme bug [#5241]
  • Speed up vagrant scheme calls by caching vagrant ssh-config [#5235]
  • Remove bug-provoking test for a bug in WPDB that was fixed [#5220]
  • Fix return types [#5212]

wp-cli/handbook

  • Update handbook for release v2.3.0 [#333]
  • Add Fedora and CentOS to installation instructions [#328]
  • Add documentation to integrate Dash/Alfred [#327]

wp-cli/wp-cli.github.com

  • Add Romanian language [#329]
  • Update Brazilian Portugues translation [#328]
  • Update Japanese translation [#326]
  • Update French translation [#324]

wp-cli/export-command

  • Allow to opt-out from dumping specific sections [#61]
  • Reuse File_Writer for STDOUT support [#60]
  • Make load_export_api() public [#59]

wp-cli/extension-command

  • Add theme status in wp theme get command [#177]
  • Fix issue with failing test cases due to version mismatch [#181]
  • Fix activation issue of installed 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 [#180]

wp-cli/i18n-command

  • Skip broken test 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. http://php.net/manual/en/intro-whatis.php. 7.3 [#178]
  • Investigate include/exclude oddities [#175]
  • Sort translation files by name to ensure same order on all systems [#173]
  • Workaround for parsing dynamic imports [#164]
  • Avoid throwing a notice about strpos(): Empty needle when going through include paths [#149]

wp-cli/media-command

  • Skip test for duplicate resizes for coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. trunk because of bug in current version [#112]
  • Clarify implications of using --skip-copy [#110]
  • Add media fix-orientation command [#108]

wp-cli/search-replace-command

  • Adds wildcards support to --skip-tables parameter [#124]

wp-cli/server-command

  • Fix port number in example [#58]

wp-cli/wp-config-transformer

  • Add EOF as special-case anchor [#23]

Contributors

@afragen, @ajoah, @blackfile, @connerbw, @drzraf, @felipeelia, @fernandoherlo, @fuegas, @fullsteamlabs, @gitlost, @greatislander, @herregroen, @hofmannsven, @jrfnl, @l3ku, @localheinz, @maximejobin, @michaelzangl, @MikeWKrystal, @mustafauysal, @ocean90, @ovidiul, @pdaalder, @sagarnasit, @schlessera, @shadyvb, @shashank3105, @siliconforks, @swissspidy, @szepeviktor, @tecking, @thrijith, @vladutilie, @wojsmol, @yognsk, @yousan

#release, #v2-3-0

WP-CLI Release v2.2.0

Phew, it’s finally here! Although there are not that many new features, we had a lot of work being done behind the scenes, to make future releases smoother. A lot of the processes have been improved, and we’ve managed to squash quite a few bugs while doing so.

A team of 57 contributors has collaborated on this release to get 347 pull requests merged. I’ll briefly go over some of the more noteworthy stuff, but as always, you can also skip directly to the detailed changelog or examine the breaking changes section if you’re impatient.

New Committer

  • Thrijith Thankachan (@thrijith) is from Surat, India. He works for rtCamp as a WordPress Engineer and he is the developer behind the two new commands alias and maintenance-mode.

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/ code standard

Through the initiative of @jrf, and with the outstanding help from @thrijith, @wojsmol & @williampatton, we now have a WP-CLI code standard that we can enforce.

For any package, you can just run composer phpcs to verify that your code meets the CS requirements. Basic formatting issues can be automatically corrected through vendor/bin/phpcbf (a Composer script will soon follow for that).

The goal of this big effort is to reduce the back & forth on pull requests and thus reduce the maintenance burden. For most pull requests, whitespace issues and code style issues represent the bulk of the time and effort required by the maintainers. With enforced and automated coding standards, everyone saves time and the discussion more often revolves around the actual logic that solves the problem, instead of alignment issues and spacing rules.

This is all pretty fresh, so stay tuned while more extensive documentation and updates to the tooling will follow.

New command to manage aliases

The old wp cli alias has finally grown up and has become a complete CRUD interface for managing your WP-CLI aliases. You can alias list to retrieve your current configuration, alias get to retrieve an individual alias, and alias add|update|delete to make changes.

While experimenting with these commands, please remember that you need to work around the already active global parameters. This is why we had to add a prefix (--set-<flag>) to all the flags that let you configure the aliases. So, updating the SSHSSH Secure SHell - a protocol for securely connecting to a remote system in addition to or in place of a password. connection string for an alias is done through alias update <key> --set-ssh=<ssh>. If you would use --ssh instead to configure it, you’d actually immediately connect to that SSH target instead.

# List alias information.
$ wp cli alias list
---
@all: Run command against every registered alias.
@local:
  user: wpcli
  path: /Users/wpcli/sites/testsite

# Get alias information.
$ wp cli alias get @dev
ssh: dev@somedeve.env:12345/home/dev/

# Add alias.
$ wp cli alias add prod --set-ssh=login@host --set-path=/path/to/wordpress/install/ --set-user=wpcli
Success: Added '@prod' alias.

# Update alias.
$ wp cli alias update @prod --set-user=newuser --set-path=/new/path/to/wordpress/install/
Success: Updated 'prod' alias.

# Delete alias.
$ wp cli alias delete @prod
Success: Deleted '@prod' alias.

New command to control maintenance mode

WP-CLI now lets you enable or disable the WordPress maintenance mode with the two simple commands maintenance activate and maintenance deactivate. You can query the current status with maintenance status (for humans) or maintenance is-active (for easy shell scripting).

# Activate Maintenance mode.
$ wp maintenance-mode activate
Enabling Maintenance mode...
Success: Activated Maintenance mode.

# Deactivate Maintenance mode.
$ wp maintenance-mode deactivate
Disabling Maintenance mode...
Success: Deactivated Maintenance mode.

# Display Maintenance mode status.
$ wp maintenance-mode status
Maintenance mode is active.

# Get Maintenance mode status for scripting purpose.
$ wp maintenance-mode is-active
$ echo $?
1

WP-CLI “binaries”

The eval-file had a small, innocuous tweak. When it encounters a “shebang“, a first line in a file that starts with #!, it will strip that line and try to run the rest of the file through 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. http://php.net/manual/en/intro-whatis.php.’s eval().

For folks not used to working in Unix shells, that might sound rather useless, but this shebang is actually a construct that your shell understands, and that lets you tell the shell how to execute the file.

As an example, here’s a file that contains such a shebang and actually points to WP-CLI’s eval-file command:

#!/bin/env wp eval-file
<?php
echo get_bloginfo('name');

With that file structure, you can now rename that script file to something like blogname and make it executable. It now behaves like any other shell tool, and will use WP-CLI as a shell framework for retrieving the current blog’s name.

Have fun experimenting with this new functionality, and don’t forget to share the more interesting use cases you can think of with the rest of the community!

Breaking changes

Name changes

While going through the code to make it fit for actually enforcing our new WP-CLI coding standard, we decided to rename some of the more internal functions, methods and properties to make the experience more consistent.

Although we took great care to figure out what we could safely rename and what needed to stay intact, there might be some edge cases where people are nevertheless directly coupling to some bit of internal code.

This is mostly relevant if you extend one of the WP-CLI classes to override default behavior.

Removal of framework files from test package

The test package included a few framework files that were used to make the FeatureContext logic work. However, as wp-cli/wp-cli was a hard requirement for wp-cli/wp-cli-tests anyway, we removed these framework files and had the test package pull them in through the dependency.

In case you were directly coupling your code to these files as they were found in wp-cli/wp-cli-tests (which is unlikely), then you’ll have to change your code to refer to these same files in the wp-cli/wp-cli package. See the pull request for more details.

Consistent display of serialized 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

Serialized data has been displayed very inconsistently, with some commands showing them as is (option list), and some commands unserializing them automatically for display (post meta list).

We’ve changed this so that they all show the values as they are stored, to avoid surprises.

This is a breaking change, however, and if you happened to rely on the automatic unserialization, you’ll be glad to hear that the affected commands now provide an optional --unserialize flag to get back to the old behavior. You can even put this flag into your global config to permanently stick with the old behavior.

Affected commands are: comment meta get|list, network meta get|list, post meta get|list, user meta get|list.

Complete change log

All repositories

  • Implement CS checking based on the WP_CLI_CS ruleset
  • Add PHP 7.3 to Travis CI build matrix
  • Move PHP 5.4 tests from WP_VERSION=latest to 5.1

wp-cli/wp-cli-bundle

  • Bundle new maintenance-mode command [#113]
  • Add a GitHubGitHub GitHub is a website that offers online implementation of git repositories that can 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/ setting for label to dependencies.yml [#74]
  • Try removing “ignore-platform-reqs” from Dependencies.yml [#72]
  • Add dependencies.yml file to define auto-updates [#70]

wp-cli/wp-cli

  • Always reattach subcommands [#5203]
  • Add warning message to let the user know when WP_CLI_SSH_PRE_CMD is in use [#5197]
  • Add aliases subcommand for backwards compatibility [#5194]
  • Avoid double registration of commands [#5193]
  • Add default titles to release checklists [#5168]
  • Limit ranges of PHP versions in Composer [#5142]
  • Add checklists for regular and patch releases [#5141]
  • Add flags to include / exclude views in wp_get_table_names() [#5128]
  • Internalize array_column() shim, because package is abandoned [#5126]
  • Add command to manage aliases [#5122]
  • Introduce ability to override wp-config.php path with env var WP_CONFIG_PATH [#5119]
  • Support persistent 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/. connections [#5115]
  • Fixed documented return type for make_progress_bar() [#5112]
  • Fix FileCache::export() not ensuring parent directories exist for $target [#5103]
  • Switch ext-readline to ‘suggest’ instead of a hard requirement [#5102]
  • Update docblock for add_command() to properly reflect the return value [#5099]
  • Fix failing test under WP 5.1 [#5094]
  • Update parse_str_to_argv() regex to be more accurate [#5090]
  • Update ISSUE_TEMPLATE [#5078]
  • Ensure cache directories are accessible [#5068]
  • Add dependencies.yml file to define auto-updates [#5066]
  • Add WP_CLI::has_config() method [#5063]
  • Change to “Happy publishing.” per change in coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. [#5059]
  • Adapt outdated links in ISSUE_TEMPLATEfile [#5056]
  • Fix typo: Autolaoder => Autoloader [#5055]

wp-cli/handbook

  • Update example of wp config create [#317]
  • Update link of backwpup 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 [#315]
  • Update release checklist documentation to point to the issue templates [#306]
  • Add wp cli info as first environment info [#305]
  • Document the <scheme> part of the --ssh flag [#299]
  • Add documentation for the --foo[=<bar>]to command-cookbook.md [#293]
  • Document WP_CLI_CUSTOM_SHELLenvironment variable [#292]
  • Change references to paths being in .bash_profile to .bashrc [#290]
  • Update roadmap [#287]
  • Add instructions for checking additional configuration files for PHP memory_limit[#286]
  • Update the ‘using a custom PHP binary’ link [#285]
  • Update hosting-companies.md [#284]
  • Update link to command list in Quick Start [#282]
  • Add a note about potential connection issues when using MySQL >= 8.0. [#280]
  • Composer installation instructions are dated and incorrect [#279]
  • Update broken links on Command Cookbook page [#276]

wp-cli/wp-cli.github.com

  • Switch to githubusercontent per other submission [#322]
  • pt_BR – Version update and minor adjustments [#321]
  • Redirect blog to site [#320]

wp-cli/checksum-command

  • Make soft change detection more flexible [#41]
  • Add backslash to the regex for matching Windows paths correctly [#39]

wp-cli/config-command

  • Update template based on latest version [#88]
  • Change Happy blogging. to Happy publishing. in wp-config.php template [#82]

wp-cli/core-command

  • Replace instances of wp.dev with example.com [#115]
  • Change to “Happy publishing.” per change in core [#103]

wp-cli/embed-command

  • Modify tests to correctly verify --force-regex flag [#50]

wp-cli/entity-command

  • Allow deleting multiple options at once [#247]
  • Fix logic error in presence of ‘site meta’ check [#244]
  • Add count to post-type 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. commands [#241]
  • Reset option value to default for privacy policy on site empty [#236]
  • Migrate term from a taxonomy to another one [#234]
  • Include ‘supports’ field when fetching a single post type [#233]
  • Check for STDIN if --post_content is used [#189]
  • Rename phpunit.xml to phpunit.xml.dist [#252]

wp-cli/eval-command

  • Strips out #! /bin/bash and similar at the beginning of PHP files [#35]
  • Fix handling of __FILE__ and __DIR__constants in eval()‘d code. [#38]

wp-cli/export-command

  • Identify non-writable directory as such [#54]

wp-cli/extension-command

  • Add the --page parameter to the theme search command [#167]
  • Allow deleting the currently active theme [#158]
  • Display warning in plugin list info if plugin version is higher than expected [#157]
  • Fix success message example on plugin uninstall [#148]
  • Handle extension activation for WP error or extension not found [#146]

wp-cli/i18n-command

  • Set Language 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. directly to prevent exceptions [#150]
  • Fix make-pot tests [#135]
  • Add script file name to 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. translation files [#134]
  • Improve language handling when creating JSON files [#133]
  • Add support for nested theme folders [#130]
  • Prevent possible PHP notice in IterableCodeExtractor [#129]
  • Extend PotGenerator to improve plural forms output [#128]
  • Remove project header comments for comments audit [#123]

wp-cli/language-command

  • Change LanguagePackUpgrader::download_packagesignature [#82]

wp-cli/media-command

  • Refactored aspects of the image collection and determination of sizes [#103]

wp-cli/package-command

  • Adapt framework requirement [#103]

wp-cli/rewrite-command

  • Update success message position [#29]

wp-cli/role-command

  • Add --show-grant argument to cap list and --grant to cap add[#19]
  • Add --field=<field> support to listing roles [#17]

wp-cli/scaffold-command

  • Prevent creating unregisterable blocks due to invalid plugin slug [#203]
  • Add dependencies.yml to plugin .distignore [#202]
  • Add DeployHQ .deployignore to ignored files in .distignore [#201]
  • Ignore various 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/. config files in plugin .distignore [#200]
  • Update links to blocks documentation [#199]

wp-cli/search-replace-command

  • Swapped out the .dev Google TLD for the .test RFC protected domain in doc examples [#107]

wp-cli/shell-command

  • Better explain the --basic flag [#23]
  • Close already opened process while prompting [#36]
  • Add possibility to change the shell binary [#33]

wp-cli/super-admin-command

  • Fix a bug where adding superadmins would crash if none existed before [#22]

wp-cli/wp-config-transformer

  • Fix parsing of escaped quotes [#16]
  • Normalize the newline to prevent an issue coming from OSX [#14]
  • Change to “Happy publishing.” per change in core [#13]
  • Add .gitattributes file [#12]

Contributors

@abhijitrakas@afragen@ajitbohra@amieiro@andreamk@andrewminion-luminfire@anthony-curtis@atanas-angelov-dev@cwales92@D9Dan@danielbachhuber@DavidHickman@dependencies[bot]@desrosj@diggy@emirpprime@felipeelia@jankimoradiya@jbwtech@jcomack@jonathanbardo@jrfnl@Juberstine@killua99@kimdcottrell@korikori@kuoko@kushalraha@lanresmith@localheinz@luc122c@man4toman@mkaz@mrmakadia94@msaggiorato@Mte90@musicaljoeker@nickdavis@nishitlangaliya@Nomafin@pattonwebz@rosswintle@salcode@shashank3105@Sidsector9@spicecadet@ssnepenthe@swissspidy@thrijith@tomjn@tyrann0us@Umang8@villuorav@websupporter@wojsmol@XedinUnknown

#release, #v2-2-0

WP-CLI v2.1.0 Release Notes

‘Tis the season to celebrate 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/! 🎄 A total of 39 contributors has collaborated on this release to have a staggering 293 pull requests merged. We’ll go over the main areas now, but you also skip directly to the detailed changelog or ponder over the breaking changes section if you’re impatient.

i18n – round two!

The recent i18n make-pot command has replace the old make-pot tool in WordPress CoreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. and is now the official translation build tool for the Core. This effort has lead to numerous improvements to make it both more robust and more flexible. Amongst the more notable changes, it can now parse 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/. in addition to the 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. http://php.net/manual/en/intro-whatis.php. files, and together with the new i18n make-json command that lets you produce separate 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. files, you’re all set to make your 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/ blocks translatable!

Translation pack improvements

We didn’t stop there with regards to making WordPress an “international success”… the language family of commands got several improvements and fixes. The most notable one is that language plugin|theme update now understands an --all flag, so you can update language packs for all your installed plugins/themes in one go.
# Update the language packs for all plugins.
$ wp language plugin update --all
Updating 'Japanese' translation for Akismet 3.1.11...
Downloading translation from https://downloads.wordpress.org/translation/plugin/akismet/3.1.11/ja.zip...
Translation updated successfully.
Updating 'Japanese' translation for Contact Forms 7 4.2.1...
https://downloads.wordpress.org/translation/plugin/contact-form-7/4.2.1/ja.zip...
Translation updated successfully.
Success: Updated 2/2 translation.

Partial prompting

The lesser known --prompt global parameter has now become even more useful. Instead of always prompting for all arguments, it skips those that were already provided, as you would probably already have expected. One way this can be used is to prefill all arguments that you can remember and then use --prompt to help you with the more arcane flags. More importantly, though, you can now prefill all the arguments that are already known inside of a script, and then add the --prompt argument to let the script query the remaining information from the user.

Manage the WP-CLI cache

We added two additional commands that let you manage the WP-CLI internal cache. cli cache clear will clear the entire cache, whereas cli cache prune will only clear the elements known to be stale. This latter will for example remove all the versions of WP core that you downloaded except for the most recent one.
# Remove all cached files.
$ wp cli cache clear
Success: Cache cleared.

# Remove all cached files except for the newest version of each one.
$ wp cli cache prune
Success: Cache pruned.

Better control over transients

You can now list the current transients on your site or network using the filterable transient list command. You can search for specific transients or exclude the ones you want to hide. You can even choose whether you want the expiration to be displayed in a human-readable or machine-parseable format.
# List all transients
$ wp transient list
+------+-------+---------------+
| name | value | expiration    |
+------+-------+---------------+
| foo  | bar   | 39 mins       |
| foo2 | bar2  | no expiration |
| foo3 | bar2  | expired       |
| foo4 | bar4  | 4 hours       |
+------+-------+---------------+
Furthermore, transients are now handled more consistently across 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. networks, and allow you to properly distinguish between regular transients and site transients.

Database management improvements

Also, the db size loved the idea of a --human-readable flag like in the transient list command so much that it got its own version. This will always use the unit that is best adapted to convey the information.
# List the size of the database in a human-readable form
$ wp db size --tables --human-readable
+---------+--------+
| Name    | Size   |
+---------+--------+
| my_site | 117 MB |
+---------+--------+
Furthermore, the db import command now understands all the flags that the mysql binary does, so that you can get past errors in SQL exports or adapt the result you want to see in your target site.
# Import an SQL export file that contains errors, by
# passing the --force argument to mysql binary.
$ wp db import export-with-errors.sql --force
Success: Imported from 'export-with-errors.sql'.

Smarter configuration

The config commands are now smarter. They not only allow you to edit the wp-config.php even on a broken WordPress installation, but you’re also able to retrieve the individual settings in whatever format best fits your scripting needs. Finally, adding new configuration values or updating existing ones will now only throw errors in the most ambiguous scenarios, while they just work for the majority use cases without the need to explicitly specify a --type.

Checking the existence of a post

You can now check whether a given post exists by using the new post exists command. It returns a shell exit code, so you can use it directly in shell conditionals.
if wp post exists 42; then
   echo "Skipping post import for ID 42, it already exists."
else
   echo "Importing post with ID 42..."
   # ...
fi

Breaking changes

  • While we had already bumped the minimum PHP version in v2.0.0 and started using PHP 5.4+ code in some places, we now actively enforce this requirement in the bootstrapping code [wp-cli#5039](https://github.com/wp-cli/wp-cli/pull/5039).
  • The restructuring of the packages in v2.0.0 produced a regression which caused overrides through the package manager to not work anymore. We fixed this by completely ripping the framework out of the regular Composer autoload flow. This should now lead to less surprises when rearranging the Composer compositions, but might have side-effects in some exotic Composer setups [wp-cli#5010](https://github.com/wp-cli/wp-cli/pull/5010).
  • The breaking change from v2.0.1 to throw an error for non-lowercase theme slugs was reverted, as it broke far more than we anticipated. That’s why we now break the breaking change to get back to the original behavior [extension-command#137](https://github.com/wp-cli/extension-command/pull/137). 😛
  • WP-CLI tries to speak proper English now. To achieve this, we changed the output to use the real world “installation” where we were using the fantasy term “install” before [wp-cli#4946](https://github.com/wp-cli/wp-cli/pull/4946).

Complete change log

wp-cli/wp-cli-bundle

  • Bump PHP version to 5.4+ for PHP Compatibility Checker [#63]
  • Bump included package-command to v2.0.3 [#35]
  • Remove .behat-progress.log [#25]
  • Use dev-master for framework instead of tagged release [#24]
  • Add replace-label maintenance command [#17]

wp-cli/wp-cli

  • Properly reorder synopsis passed in via $args [#5049]
  • Bump PHP version check in bootstrap code to v5.4+ [#5039]
  • Remove ext-posix requirement from Composer file [#5038]
  • Fix override test on Composer stack [#5036]
  • PHP 7.0+: allow for changed list assignment order [#5021]
  • Skip associative arguments that were already provided on --prompt [#5015]
  • Bump PHP version to 5.4+ for PHP Compatibility Checker [#5014]
  • Use custom autoloader to load framework [#5010]
  • Add extension requirements to composer.json file [#5001]
  • Add ext-zip as suggested extension [#4998]
  • Fix parsing of arguments for WP_CLI::runcommand() with launch=false [#4989]
  • Match the way WordPress Core locates wp-config.php [#4984]
  • Use dirname() instead of .. to locate wp-config.php to match Core behavior [#4963]
  • Update README to account for the 280-character limit on Twitter [#4962]
  • Use “installation” instead of “install” in documentation [#4960]
  • Bump included package-command to v2.0.3 [#4957]
  • Reattach existing subcommands from namespace to replacing command [#4951]
  • Convert ‘install’ to ‘installation’ [#4946]
  • Add sibling vendor folder location [#4938]
  • Check and display help command if requested [#4928]
  • Fix var_export return in WP_CLI::print_value [#4926]
  • Adapt README.md file for v2.0.1 release [#4924]
  • Bump version to 2.1.0-alpha [#4898]
  • Added cli cache prune & cli cache clear commands [#4787]

wp-cli/handbook

  • Add Savvii to hosting companies [#267]
  • Update hosting-companies.md [#266]
  • Update the set up and testing flow [#265]
  • History | grep = even better than ctrl-r [#263]
  • Please add One.com to the list [#261]
  • Add lima-city to hosting companies [#258]
  • Add 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 Simple History [#257]
  • Update running-commands-remotely.md to add ~/bin approach [#256]
  • Use “installation” instead of “install” [#255]
  • Fix issue with broken filename [#253]
  • Document root cause to STDOUT PHP notice [#252]
  • Update with v2 changes [#251]
  • Remove WP_CLI_Command class [#250]
  • Include the cron jobs in the governance document [#248]

wp-cli/wp-cli.github.com

  • Updated index.md – Spanish version [#316]
  • Adapt index.md file for v2.0.1 release [#315]

wp-cli/cache-command

  • Rename transient list method to be consistent with other list commands [#49]
  • Introduce a list command to list all transients [#48]
  • Make output of transient type generic to include multisite behaviour [#47]
  • Replace usage of global with wp_using_ext_object_cache() [#45]
  • Improve deleting site transients [#42]

wp-cli/checksum-command

  • Use command namespaces instead of conditional addition [#54]

wp-cli/config-command

  • Permit use of wp config edit when WP isn’t functional [#71]
  • Use constant as default type when adding new keys [#80]
  • Add --format option for config get command [#79]
  • Use print_value() instead of log() for output of config get [#78]

wp-cli/core-command

  • Switch to wp-cli@dev [#92]
  • Adapt install => installation in tests [#90]
  • Fix tests for uncached nightly downloads [#100]
  • Adapt framework requirement [#101]

wp-cli/cron-command

  • Make sure WP Cron is enabled for cron tests [#36]

wp-cli/db-command

  • Fix comment argument test [#127]
  • Adds --human-readable parameter to db size command [#124]
  • Support all mysql flags while importing database [#123]
  • Add search and delete example [#122]
  • Add new db clean to README.md and configuration files [#119]
  • Fix combination of --format & --size_format flags [#118]
  • Add links to 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/. documentation [#117]

wp-cli/entity-command

  • Update readme [#204]
  • Bump site meta test requirement to WP 5.1+ [#225]
  • Add missing --description flag logic for user create [#217]
  • Expose the available query variables for comment and post queries [#213]
  • Use “installation” instead of “install” [#212]
  • List all entities in the package description [#208]
  • Bail with a warning when deleting custom post types without --force [#188]
  • Add post exists command [#182]

wp-cli/eval-command

  • Adapt install => installation in tests [#33]

wp-cli/extension-command

  • Throw error in theme fetcher on non-lowercase slugs [#126]
  • Raise timeout for 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. requests to 1 minute [#125]
  • Revert “Throw error in theme fetcher on non-lowercase slugs” [#137]
  • Failed plugin updates now throw errors [#143]
  • Use “installation” instead of “install” [#139]
  • plugin delete <plugin-name> not working if path has a space or & in it [#138]

wp-cli/i18n-command

  • Require framework as hard dependency [#78]
  • Add Composer config settings [#74]
  • Improve detection of translator’s comments [#101]
  • Improve regex replacement [#100]
  • Replace regexes Peast can’t parse [#99]
  • Allow skipping strings audit [#94]
  • Update file-comment argument docs [#93]
  • Set a placeholder PO-Revision-Date 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. [#92]
  • Remove ‘foo’ file [#88]
  • Include should override exclude instead of the other way around [#87]
  • Support parsing minified JS files created by WebPack [#85]
  • Add unit test cases for include/exclude options [#83]
  • Allow passing an empty file comment [#82]
  • Determine includes and excludes based on scores [#104]
  • Add parsing of .js.map files to improve reliability of JS translations [#103]
  • Remove second argument to WP_CLI::success() [#112]
  • Normalize paths [#111]
  • Normalize paths [#110]
  • Add i18n make-json command [#109]

wp-cli/language-command

  • Make sure upgrader strings are always in English [#54]
  • Slug fixes [#53]
  • Change access to activate_language() to private [#47]
  • Don’t error when a translation is not yet available [#69]
  • Check if array key exists to prevent undefined index notices [#67]
  • Support installing translations for all installed plugins/themes [#64]
  • Make use of report_batch_operation_results() for install commands [#63]
  • Continue if $available_updates is not a array [#62]
  • Add tests for wp site switch-language [#57]

wp-cli/media-command

  • Fix SVG regeneration test by adding an XML header to fake SVG file [#98]

wp-cli/package-command

  • Make tests work with both install and installation strings [#100]

wp-cli/php-cli-tools

  • Use forced width attribution as fallback only to avoid scrapping manual widths [#136]
  • Fix incorrect namespace for cli\notify\xxx [#137]

wp-cli/scaffold-command

  • PHPCSPHP Code Sniffer PHP Code Sniffer, a popular tool for analyzing code quality. The WordPress Coding Standards rely on PHPCS. template: fix XML error in ruleset [#171]
  • Add textdomain to blockBlock Block is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage using the WordPress editor. The idea combines concepts of what in the past may have achieved with shortcodes, custom HTML, and embed discovery into a single consistent API and user experience. strings and update tests accordingly [#187]
  • Use branch for WP_TEST_TAG for RCRelease Candidate A beta version of software with the potential to be a final product, which is ready to release unless significant bugs emerge. and betaBeta A pre-release of software that is given out to a large group of users to trial under real conditions. Beta versions have gone through alpha testing in-house and are generally fairly close in look, feel and function to the final product; however, design changes often occur as part of the process. [#186]
  • Missing text domain in post_type_extended.mustache [#184]
  • Work around Travis CI issue with _s download certificate [#182]
  • Fix typo in Travis config [#180]
  • Ignore ‘node_modules’ in PHPCS XML file [#178]
  • Allow for installation as well as install [#177]
  • Fix syntax error in block-php.mustache [#176]
  • Inc ‘menu_position’ when scaffolding a post type [#173]
  • Remove Inflector Class [#172]
  • Run docker-php-ext-install with sudo -E in CircleCI [#188]
  • Split up the list of expected files to allow for WP 5.0+ changes [#195]

wp-cli/search-replace-command

  • Corrects NULL export values. [#93]

wp-cli/server-command

  • Set SERVER_ADDR for the built-in webserver [#49]

wp-cli/wp-config-transformer

  • Add regression test for #5 [#8]
  • Remove colloquialism [#6]
  • Preserve leading whitespace characters on config update [#5]
  • Fix regex for closing syntax in string [#9]
  • Use real config filename in Exception messages [#11]

Contributors

Please give a big round of applause to these fine folks that have contributed their time and expertise to make this release possible: @abhijitrakas, @antigenius, @austinginder, @BhargavBhandari90, @birkestroem, @bitwombat, @bonny, @Calinou, @danielbachhuber, @dgroddick, @emirpprime, @fjarrett, @frozzare, @GaryJones, @Grucqq, @henrywright, @herregroen, @insomnux, @jrfnl, @KushibikiMashu, @markjaquith, @MoisesMN, @Mte90, @ocean90, @phillipp, @pmgarman, @rmccue, @siliconforks, @soulseekah, @swissspidy, @szepeviktor, @thrijith, @torounit, @tsmith1, @VladimirAus, @wojsmol, @yahilmadakiya, @yousan Thank you! ❤️

#release, #v2-1-0

WP-CLI v2.0.0 Release Notes

This is a big one! 67 awesome contributors have collaborated over 364 pull requests to bring you 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/ v2!

Before going over the detailed change log, let’s discuss a few key areas of this update in more detail. There’s also a “Breaking changes” further down in the document.

“Framework” & “Bundle” are now two separate packages

This is the main change we planned to include with version 2 of WP-CLI. From v2 onwards, the “framework” is a separate package from the “bundle” that is used to build the Phar file you can download. The framework is now contained within the wp-cli/wp-cli package, while the bundling has moved on to the wp-cli/wp-cli-bundle.

Agreed, this does not sound like such a big deal, but in terms of development experience and maintenance effort, it is a tremendous improvement, making almost every future change faster and simpler.

What does that mean for users working with the Phar version of WP-CLI ?

Nothing much, really. Apart from some of the debugging information containing different paths, you won’t see much of a difference. One of the goals was to not disrupt current usage more than necessary. If you only ever download the WP-CLI Phar and use that to control your sites, you should not need to care about this change.

What does this mean for site owners using WP-CLI through Composer ?

They will rejoice! The framework itself has gotten rid of most of its problematic dependencies. If you compare the dependencies of v1.5.1 with those of v2.0.0, you’ll see that the list is drastically shorter. Also, the most problematic set of the dependencies, the hard requirement on an old version of Symfony, is gone. The only Symfony component we still have (yet) is symfony/finder, as there’s no upper version limit for that one.

Most of the more problematic dependencies actually came from the WP-CLI package manager (wp-cli/package-command). That command is not only optional now, there’s also no valid reason to use it at all when pulling WP-CLI in via Composer directly.

This also means that you will not see WP-CLI automatically pull in all bundled commands automatically. Let’s say, you need the wp-cli/db-command for some maintenance tasks for your site. With v1.5.1, this would have pulled in the entire WP-CLI bundle as a dependency. With v2.0.0, it will only pull in the lean framework as a dependency, nothing more. You’ll end up with a WP-CLI active on your site that contains the commands clihelp (as the two “built-ins”) and db.

As a nice side-benefit, this makes WP-CLI run much faster in such scenarios, as it only loads what is effectively needed for the site. The difference might not seem like much, but depending on how you use in in your scripts, it can make a big difference.

What does this mean for developers working on third-party WP-CLI commands?

Splitting everything up has provided a few additional perks for developers (see also the next section about the testing improvements). Everything is leaner, and the dependency resolutions are less problematic, as we got rid of that one nasty circular dependency (command requires framework => framework equals bundle => bundle requires command).

However, dependency declarations need to be more explicit now. If you require wp-cli/wp-cli, this will only provide the pure framework. You cannot implicitly rely on any of the bundled commands in that case, you’ll have to explicitly require any additional command you might need.

Testing framework is now a separate package

One of the things that bothered me a lot while maintaining WP-CLI was the fact that the testing infrastructure was “scaffolded” into the individual command packages (just as it is into the third-party commands). This basically means that we copy-pasted the code in there, and if the code needs to change (because of a bug being fixed or an improvement being made), we have to create changes in every single package to overwrite the copy-pasted version of the testing code with an updated one.

Now we have the testing infrastructure abstracted away into a separate package: wp-cli/wp-cli-tests. For this first iteration, it includes out-of-the-box support for 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. http://php.net/manual/en/intro-whatis.php. linting, PHP Code SnifferPHP Code Sniffer PHP Code Sniffer, a popular tool for analyzing code quality. The WordPress Coding Standards rely on PHPCS. checks (including the WordPress Coding StandardsWordPress Coding Standards A collection of PHP_CodeSniffer rules (sniffs) to validate code developed for WordPress. It ensures code quality and adherence to coding conventions, especially the official standards for WordPress Core. and the PHP Compatibility Checks), PHPUnit unit tests and Behat functional tests. They are set up in such a way that they detect whether they should run, based on config files or test files presence.

A simple composer test will run all of the tests in order. But you can also run them individually, through composer lint|phpcs|phpunit|behat. Adding further configuration flags can be done as well, but you need to remember to prepend them with a double-dash ( --) first, otherwise the arguments will be interpreted by Composer itself.

For the most important tests, the functional Behat tests, you can also define some constants to adapt the environment in which to test. For example, testing against a specific version of WordPress can be done by providing the WP_VERSION constant: WP_VERSION=4.2 composer behat. This constant also understands latest and trunk correctly.

In general, the tests are set up in such a way that you’ll face less differences between what you get locally and what you’ll get inside of the Travis CI checks.

And given that the tests can now be worked on in one central location, we’re already thinking about what our next steps are to further improve them, like letting you easily re-run only the failed scenarios from last run or automatically retrying failures on Travis to make sure it was not a random intermittent timeout or similar.

New command: i18n make-pot

@swissspidy has spent countless hours working on a new command that has now finally made it into the official WP-CLI bundle. We now introduce you to the i18n command family and its first usable subcommand, i18n make-pot.

What started out as an exploration at first is now a robust tool that is already being used in production systems and is even planned to replace the default translation tool bundled with WordPress Core. It supports both PHP and 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/., can manipulate and put into shape multiple files and even detected bugs in the original CoreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. tooling.

This can now easily be including in whatever automated tooling you use for your site/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 development, and should make your translation work much smoother. Here’s a quick rundown of the main features:

  • Automatically detects plugins and themes and extracts file headers.
  • Allows extraction of only a specific text domain.
  • Supports JavaScript string extraction, even for JSX and ESNext.
  • Allows merging the resulting POT file with an existing one, e.g. one created by Babel.
  • Powerful rules to include/exclude specific directories (minified JS files, vendor, .git folder, etc.).
  • Supports extracting strings from WordPress core the same way it’s done today with 4 different projects. See https://github.com/wp-cli/i18n-command/pull/69 for examples.
  • Can warn about strings with wrong placeholders, as well as misleading or missing translator comments. This could be very useful for core but also plugin/developers to improve polyglots UXUX UX is an acronym for User Experience - the way the user uses the UI. Think ‘what they are doing’ and less about how they do it..

A big shoutout to @swissspidy for the fabulous work he did on that command!

Minor Framework enhancements

New WordPress action: 'cli_init'

We introduced a new action 'cli_init' that will be triggered by WP-CLI during the 'plugins_loaded' action. This can be used as a conditional trigger for loading WP_CLI specific code, in case you don’t want to use the constants we already provide, for whatever reason.

This being a WordPress action, it adds a bit more flexibility to the process of loading a WP-CLI command, like for example one plugin being able to unhook the commands of another plugin.

New command: config edit

Easily open your wp-config.php in your favorite editor (configured through the EDITOR environment variable). Once you save within that editor, the wp-config.php will be correctly updated.

Note: This works through SSHSSH Secure SHell - a protocol for securely connecting to a remote system in addition to or in place of a password./vagrant/docker tunnels as well, but keep in mind that it will use the EDITOR of the remote system, which should be something like vim (=> “how to exit the vim editor” 😉).

# Launch system editor to edit wp-config.php file
$ wp config edit

# Edit wp-config.php file in a specific editor
$ EDITOR=vim wp config edit

New command: config shuffle-salts

This refreshes the salts stored in your wp-config.php file, which are cryptographic values used for authentication and other security-related functionality. Regulary refreshing these salts could be considered “security hygiene” for a site.

The command will generate the salts locally if your PHP server environment is cryptographically secure enough to do so, and falls back to the remote wordpress.orgWordPress.org The community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/ 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. endpoint if not.

# Get new salts for your wp-config.php file
$ wp config shuffle-salts
Success: Shuffled the salt keys.

New command: db columns

Get a tabular view of the table schema for a given table. It shows you how the individual columns of the table have been defined, which default values they use and what extra functionality might be attached to them.

$ wp db columns wp_posts
+-----------------------+---------------------+------+-----+---------------------+----------------+
|         Field         |        Type         | Null | Key |       Default       |     Extra      |
+-----------------------+---------------------+------+-----+---------------------+----------------+
| ID                    | bigint(20) unsigned | NO   | PRI |                     | auto_increment |
| post_author           | bigint(20) unsigned | NO   | MUL | 0                   |                |
| post_date             | datetime            | NO   |     | 0000-00-00 00:00:00 |                |
| post_date_gmt         | datetime            | NO   |     | 0000-00-00 00:00:00 |                |
| post_content          | longtext            | NO   |     |                     |                |
| post_title            | text                | NO   |     |                     |                |
| post_excerpt          | text                | NO   |     |                     |                |
| post_status           | varchar(20)         | NO   |     | publish             |                |
| comment_status        | varchar(20)         | NO   |     | open                |                |
| ping_status           | varchar(20)         | NO   |     | open                |                |
| post_password         | varchar(255)        | NO   |     |                     |                |
| post_name             | varchar(200)        | NO   | MUL |                     |                |
| to_ping               | text                | NO   |     |                     |                |
| pinged                | text                | NO   |     |                     |                |
| post_modified         | datetime            | NO   |     | 0000-00-00 00:00:00 |                |
| post_modified_gmt     | datetime            | NO   |     | 0000-00-00 00:00:00 |                |
| post_content_filtered | longtext            | NO   |     |                     |                |
| post_parent           | bigint(20) unsigned | NO   | MUL | 0                   |                |
| guid                  | varchar(255)        | NO   |     |                     |                |
| menu_order            | int(11)             | NO   |     | 0                   |                |
| post_type             | varchar(20)         | NO   | MUL | post                |                |
| post_mime_type        | varchar(100)        | NO   |     |                     |                |
| comment_count         | bigint(20)          | NO   |     | 0                   |                |
+-----------------------+---------------------+------+-----+---------------------+----------------+

New command: db clean

We already had db reset, but that dropped the entire database… which is not a nice thing to do if there’s more than a default WordPress site in there 😱!

The new db clean will only drop the tables that are actually part of the current WordPress installation and leave the rest of the database instance intact.

# Delete all tables that match the current site prefix.
$ wp db clean --yes
Success: Tables dropped.

New command: site meta

We’ve added CRUD methods adddeletegetlistpatch, pluck and update for the “site 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.” entities.

Oh, and while you are wondering… Yes, you are right, WordPress does not have “site meta” entities. But we didn’t lose our minds: WordPress will introduce “site meta”, together with a wp_site_meta table, with its 5.0 version. We just like to be prepared, that’s all… 😜

# Set site meta
$ wp site meta set 123 bio "Mary is a WordPress developer."
Success: Updated custom field 'bio'.

# Get site meta
$ wp site meta get 123 bio
Mary is a WordPress developer.

# Update site meta
$ wp site meta update 123 bio "Mary is an awesome WordPress developer."
Success: Updated custom field 'bio'.

# Delete site meta
$ wp site meta delete 123 bio
Success: Deleted custom field.

New command: user check-password

You can now let WordPress tell you whether a given password is valid for a specific user. This is NOT an endorsement to build your authentication layer with Bash scripts! But who knows what exotic automation needs the DevOps folks will come up with…

The command will let you know through a shell exit code whether the password was valid or not, so you can use it directly in if conditionals.

# Check whether given credentials are valid; exit status 0 if valid, otherwise 1
$ wp user check-password admin adminpass
$ echo $?
1

# Bash script for checking whether given credentials are valid or not
if ! $(wp user check-password $USER $PASSWORD); then
    notify-send "Invalid Credentials";
fi

New commands: language plugin and language theme

They both come with the following subcommands: install, update, uninstall, list and is-installed (which was added to core language as well).

You can now fully control all of the language files of your installation individually.

# Install the Dutch theme language pack.
$ wp language plugin install hello-dolly nl_NL
Success: Language installed.

# Uninstall the Dutch theme language pack.
$ wp language plugin uninstall hello-dolly nl_NL
Success: Language uninstalled.

# List installed theme language packages.
$ wp language plugin list --status=installed
+----------+--------------+-------------+-----------+-----------+---------------------+
| language | english_name | native_name | status | update | updated |
+----------+--------------+-------------+-----------+-----------+---------------------+
| nl_NL | Dutch | Nederlands | installed | available | 2016-05-13 08:12:50 |
+----------+--------------+-------------+-----------+-----------+---------------------+

Changes to existing command

  • db size now knows about ISO size units as well
  • option list got a new --unserialize flag
  • post generate can now deal with --post_date_gmt
  • user update now allows you to --skip-email
  • eval-file can read from STDIN
  • Both plugin uninstall and plugin delete can now act on --all plugins at once
  • cap list can now --show-grant
  • cap add , seeing what its list sibling had done, grew a new --grant flag
  • role list can now print a single --field=<field>
  • scaffold _s learned the new --woocommerce trick
  • search-replace lets you set a --regex-limit

Automated README.md updates

If you have ever contributed to WP-CLI and made a change to a command signature or documentation, you probably had me tell you that you needed to regenerate the README.md as well using the wp scaffold package-readme . --force command. No more!

We have now added a package wp-cli/regenerate-readme that automates this process. It adds both a precommit and a postcommit git hook that collaborate to transparently regenerate the README.md file behind the scenes and then amend your commit to add the required changes automatically.

This has not been deployedDeploy Launching code from a local development environment to the production web server, so that it's available to visitors. to all command packages yet while we still experiment with some of the finer points of its implementation, but you’ll slowly see the annoying “please regenerate README.md kthxbye” reminders from my side disappear and become forgotten artifacts of the past.

Improved debug output

The debug output was always a bit sparse for WP-CLI. This is why we took the opportunity of v2 to improve upon it and make it more useful. It will now add debug messages for the 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. that are triggered, or details about how commands are being loaded or deferred. This will be very useful for third-party command developers that ignore why their command is not properly registered.

We’ll make sure to add even more useful debugging information in the future.

Small side note: To make debugging work as early as possible, it is now smart enough to just store all messages until the logger it needs to send them to becomes available. This means you don’t need to worry about the timing here, if the WP_CLI exits for your code, the debugger is good to go!

Breaking changes

Here are a few things you need to be aware of when moving from ^v1 to ^v2:

  • An obvious breaking change is the bump to the minimum version of PHP. This will break for anyone trying to run WP-CLI on PHP 5.3.
  • The separation of the “framework” and the “bundle” into two separate packages will cause a breaking change if a third-party command is being pulled-in via Composer AND that third-party command relies on running bundled commands as well. This will seldom be the case and will be an easy fix. Installations using the Phar will not be impacted.
  • As many dependencies could be removed from the framework by not including the package manager automatically, any third-party command that relies on one of the removed Symfony packages or other dependencies AND hasn’t declared that requirement in its own Composer configuration will break. This will seldom be the case and will be an easy fix. Installations using the Phar will not be impacted as the package manager still comes with these requirements included.
  • The versions of some the dependencies will be bumped. If you happen to not lock WP-CLI into a specific version constraint, but do so for some of its dependencies, you might see a version constraint conflict when using Composer.
  • Any external code that relies on internal file structure, file naming or other internal details that are not part of the provided API could run the risk of breaking due to us moving things around from v1 to v2. This should hopefully not ever be the case, but you never know…
  • As a side-effect of adding the --all flag to plugin uninstall, a breaking change was introduced for consistency reasons. Whereas WP-CLI used to consider uninstalling a non-existent plugin as a “Success: Plugin already uninstalled”, it will now throw an error “Error: No plugin uninstalled”.
  • We did our best to avoid unnecessary breaking changes. But with a big structural change like we have here, the devil’s in the details. Let us know if you hit any other issues!

Complete change log

wp-cli/wp-cli-bundle

  • Bundle wp-cli/i18n-command [#9]

wp-cli/wp-cli

  • Add Inflector class and convenience function for pluralizing nouns [#4881]
  • Adapt regular expression in make-phar test to skip wiki links [#4873]
  • PHPCSPHP Code Sniffer PHP Code Sniffer, a popular tool for analyzing code quality. The WordPress Coding Standards rely on PHPCS. Config Refresh [#4867]
  • Fix PHP version check [#4864]
  • Trigger new 'cli_init' hook during WordPress 'plugins_loaded' action. [#4861]
  • add template for core-command to phar [#4854]
  • Fall back to full string instead of $mode on PHP < 7 [#4853]
  • Refactoring wp-cli/wp-cli to represent the framework only, not the bundle [#4851]
  • Remove WP 4.4 requirement [#4845]
  • Fix —skip-theme tests [#4843]
  • Fix shell scripting issues in ci/deploy.sh [#4842]
  • Fix shell scripting issues in bin/wp [#4841]
  • Additional quoting in ci/prepare.sh [#4840]
  • Lock wp-completion.bash to v1.5.1 [#4839]
  • Remove Gemnasium badge, as the service was shut down [#4815]
  • Use latest search-replace package to fix tests broken due to privacy policy change [#4807]
  • Turn 'latest' into version number [#4806]
  • Update packages to fix broken tests due to WP5.0 [#4804]
  • Switch to fixed package command [#4803]
  • Bump lowest PHP version to test to 5.4 [#4798]
  • Add a missing accepted output format to wp cli alias [#4765]
  • Improve the descriptions of the --skip-plugins and --skip-themes flags [#4759]
  • Include sublinks in README.md to popular installation methods [#4756]
  • ABSPATH defined [#4743]
  • Skip wp_blogmeta table for back compat [#4736]
  • Introduce \WP_CLI\Utils\normalize_path function. Using it for ABSPATH constant. [#4718]
  • Undo temporary one-off @require-php-5.4 in bootstrap test. [#4716]
  • Revert “Require minimum PHP 5.4” [#4715]
  • Skip pre-commit hook in auto-composer-update [#4711]
  • Revert “update wp cli info” [#4702]
  • Remove : from cli update info check. [#4697]
  • Only check staged files during the pre-commit PHPCS verification [#4696]
  • Empty domain in framework test after get_sites_by_path change. [#4695]
  • Append uniq_id() when extracting file from Phar [#4692]
  • Support launching system editor with specific temp file extension [#4691]
  • Script to create the GitGit Git is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency. Git is easy to learn and has a tiny footprint with lightning fast performance. Most modern plugin and theme development is being done with this version control system. https://git-scm.com/. pre-commit hook. [#4622]
  • Update wp cli info [#4613]

wp-cli/handbook

  • Add documentation on how to troubleshoot [#243]
  • Use <example.com> as placeholder [#242]
  • Fix typos in <code-review.md> [#239] & [#241]
  • Remove Dead Link [#238]
  • Update docs for installing WP-CLI via brew [#236]
  • Add quotes to the alias [#235]
  • Adapt signing procedure to use proper key [#232]
  • Added the optimize WP CLICLI Command Line Interface. Terminal (Bash) in Mac, Command Prompt in Windows, or WP-CLI for WordPress. command of the WP-Optimize Plugin [#231]
  • Add an updraftplus WP CLI command [#228]
  • Fix grammar in documentation paragraph [#226]
  • Add a LICENSE file to the repo [#224]
  • Incorporate a few strategic mentions of the wp-cli/ideas repo [#223]
  • Remove the wish list from the website [#222]
  • Document WP_CLI_PHP_ARGS in WP-CLI config document [#221]
  • Mention the Docker installing method [#220]
  • Document issue of creating a post with Latin characters in title [#214]
  • Add BOM in wp-config.php as a common issue. [#212]
  • Add WP_CLI_PHP to Environment variables [#211]
  • Fix missing quote in documentation [#210]
  • Separate non-bundled install; generate against current WP-CLI instance. [#207]
  • Update Daniel’s relationship to the project [#206]

wp-cli/wp-cli.github.com

  • Updated <index.md> for Spanish language [#313]
  • Remove Gemnasium badge [#312]
  • Update pt_BR translation [#311]
  • Add a LICENSE file to the repo [#309]
  • Add note about only using the English version as source for translations [#308]
  • Translate homepage into Spanish [#307]
  • Changed http to https in all wp-cli.org links. [#305]

wp-cli/autoload-splitter

  • Package is now obsolete as of v2.0.0

wp-cli/cache-command

  • Adapt package for framework v2 [#32]

wp-cli/checksum-command

  • Make soft changes more flexible for plugin checksums [#43]
  • More flexible soft change checks (issue #34) [#41]
  • Add backslash to the regex for matching Windows paths correctly [#39]
  • Scaffold correct GitHubGitHub GitHub is a website that offers online implementation of git repositories that can 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/ labels [#37]
  • Adapt package for framework v2 [#50]

wp-cli/config-command

  • Fix library version to ^1.2.1 [#53]
  • Removed leftover remove() operation [#52]
  • Introduce config edit command [#48]
  • Add higher timeout config value [#67]
  • Adapt package for framework v2 [#66]
  • Ensure file_put_contents() writes to the wp-config.php path [#63]
  • Add shuffle-salts command [#62]
  • Set WP_CACHE_KEY_SALT [#59]

wp-cli/core-command

  • Bring template files over from wp-cli/wp-cli [#73]
  • Fix mustache template file path [#77] & [#78]
  • Sanitize database at the end of install to prevent duplicate data [#76]
  • Adapt package for framework v2 [#81]

wp-cli/cron-command

  • Adapt package for framework v2 [#29]

wp-cli/db-command

  • Add db columns command [#100]
  • Count users instead of posts for the smoke test [#98]
  • Fix test failure due to introduction of wp_blogmeta table [#94]
  • Add db clean command [#93]
  • Add examples for exporting certain posts [#90]
  • pass --column-statistics=0 to mysqldump command [#105]
  • Add ISO size formats to db size [#104]
  • Adapt package for framework v2 [#110]

wp-cli/embed-command

  • Adapt package for framework v2 [#38]
  • Scaffold missing top-level commands [#35]

wp-cli/entity-command

  • Fix tests after Core’s introduction of a default “Privacy Policy” page [#177]
  • Abstract meta CRUD into methods [#174]
  • Remove duplicative --user_email=<user-email> argument [#173]
  • Turn latest into actual version number [#171]
  • Improve the formatting of various format parameter documentation [#168]
  • Add site meta sub-command [#159]
  • Add --unserialize flag to option list command [#156]
  • Add --from-post=<post_id> flag to create duplicate posts [#154]
  • Properly clone objects for comparison [#152]
  • Fix missing quote in documentation [#147]
  • Fix categoryCategory The 'category' taxonomy lets you group posts / content together that share a common bond. Categories are pre-defined and broad ranging. list count [#146]
  • Add user check-password subcommand [#144]
  • Replace ‘install’ to ‘installation.’ [#187]
  • Add support for --post_date_gmt in post generate [#184]
  • Optional --skip-email flag for wp user update [#155]
  • Adapt package for framework v2 [#192]

wp-cli/eval-command

  • Adapt package for framework v2 [#27]
  • Support eval-file from STDIN (implementation for #19) [#21]

wp-cli/export-command

  • Start with an empty site to avoid count issues [#36]
  • Adapt package for framework v2 [#44]

wp-cli/extension-command

  • Add missing templates to this repository [#107]
  • Replace retired themes used in tests with new ones [#105]
  • Introduce theme mod list [#100]
  • Refresh README.md and test suite prior to v1.1.10 release. [#89]
  • Allow for modern-wordpress redirect [#85]
  • Add --all flag for plugin uninstall command [#84]
  • Fix mustache file paths [#109] & [#112]
  • Search: Add plugin or theme’s URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org on <wordpress.org> [#108]
  • Add --all flag to plugin delete [#103]
  • Adapt package for framework v2 [#116]

wp-cli/i18n-command

  • Prepare for v2 release [#72]
  • WordPress Core support [#69]
  • Check for more mistakes in translatable strings [#64]
  • Separate translation extraction from Po file writing [#63]
  • Make PhpFunctionsScanner extensibleExtensible This is the ability to add additional functionality to the code. Plugins extend the WordPress core software. [#62]
  • Separate command argument handling from actual __invoke() [#60]
  • Add --headers parameter [#58]
  • Add X-Generator 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. to POT file [#57]
  • Print some more helpful debug messages [#56]
  • Factor directory iterator as a trait [#54]
  • Text domain header [#43]
  • Add @when before_wp_load to command namespace [#42]
  • Add option to extract strings with any text domain [#38]
  • Correctly pass exclude option to JsCodeExtractor [#37]
  • Add warning when a string has two different translator comments [#34]
  • Exclude some common directories [#32]
  • Add ability to merge with existing POT file [#31]
  • JavaScript String Extraction [#26]
  • Don’t try to extract anything when there are no PHP files [#24]
  • Add more tests related to translator comments [#23]
  • Standardize file names [#21]
  • Extract all supported functions. [#13]

wp-cli/import-command

  • Adapt post/page generation to make them resilient to added privacy policy page [#25]
  • Adapt package for framework v2 [#30]

wp-cli/language-command

  • Revert “Add plugin and theme command” [#28]
  • Adapt package for framework v2 [#43]
  • Use download_url() in language pack upgrader [#41]
  • Enable updating languages for individual plugins and themes [#40]
  • Warn if no plugin or theme has been specified [#38]
  • Add is-installed command to check if a given language is installed [#36]
  • Update language core update --dry-run message [#32]
  • Add language plugin and language theme command. [#29]

wp-cli/media-command

  • Adapt package for framework v2 [#85]
  • Update examples in documentation [#81]
  • Reinstate ghostscript/imagick install and fix bmp name in regenerate test. [#69]
  • Document how to fetch attachment URL after import [#68]
  • Clear WP object cache periodically on media regenerate/import. [#62]

wp-cli/package-command

  • Assume default package name if composer.json file cannot be retrieved [#78]
  • Avoid using Composer CA bundle if in phar. [#73]
  • Move test-command to wp-cli-test Github organization [#66]
  • Extract SSLSSL Secure Socket Layer - Encryption from the server to the browser and back. Prevents prying eyes from seeing what you are sending between your browser and the server. certificate from Phar first before using it in Composer [#83]
  • Adapt package for framework v2 [#87]
  • Exclude broken Composer version [#91]

wp-cli/php-cli-tools

  • Remove double semi-colon [#130]
  • Fix potential endless loopLoop The Loop is PHP code used by WordPress to display posts. Using The Loop, WordPress processes each post to be displayed on the current page, and formats it according to how it matches specified criteria within The Loop tags. Any HTML or PHP code in the Loop will be processed on each post. https://codex.wordpress.org/The_Loop. in prompt() [#129]
  • Fix off-by-1 error in progress bar examples [#128]
  • Add optional $msg parameter to cli\Progress\Bar::tick() [#126]

wp-cli/rewrite-command

  • Adapt package for framework v2 [#20]

wp-cli/role-command

  • add --show-grant argument to wp cap list and --grant to wp cap add [#19]
  • Add --field=<field> support to listing roles [#17]
  • Adapt package for framework v2 [#23]

wp-cli/scaffold-command

  • Skip PHPUnit tests for PHP 7.2+ [#145]
  • Modify scaffold block to create index.js [#142]
  • Fix theme-specific paths in scaffolded blocks [#137]
  • Add PHP 7.2 to CI templates [#135]
  • Exclude tests/test-sample.php via the phpunit.xml.dist file [#134]
  • Fix sed -i option on MacOS [#132]
  • Use correct default $WP_TESTS_DIR on MacOS [#131]
  • Use phpunit 6.5.6 for PHP 7.2 to get around core test incompat. [#125]
  • Fix WPCSWordPress Coding Standards A collection of PHP_CodeSniffer rules (sniffs) to validate code developed for WordPress. It ensures code quality and adherence to coding conventions, especially the official standards for WordPress Core. in theme-tests generation [#121]
  • Switch CircleCI template to CircleCI 2.0. [#115]
  • Correct 'add_new_item' label [#163]
  • Exclude string from escape warning [#162]
  • Update PHPCS default rule set [#161]
  • Add --woocommerce flag to scaffold _s command [#159]
  • Add PHPCompatibility sniffssniff A module for PHP Code Sniffer that analyzes code for a specific problem. Multiple stiffs are combined to create a PHPCS standard. The term is named because it detects code smells, similar to how a dog would "sniff" out food. to scaffolded [#154]
  • Add escaping for blockBlock Block is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage using the WordPress editor. The idea combines concepts of what in the past may have achieved with shortcodes, custom HTML, and embed discovery into a single consistent API and user experience. title [#153]
  • Remove 'wp-blocks' from style dependency [#151]
  • Add function_exists() check to block PHP template [#147]
  • Adapt package for framework v2 [#166]

wp-cli/search-replace-command

  • Fix tests that are broken due to the addition of a “Privacy Policy” page [#78]
  • Handle incomplete class (un)serialization gracefully [#76]
  • Handle PCRE errors gracefully [#75]
  • Remove “Site Not Found” message from 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. usage [#69]
  • Fix broken GUID test [#81]
  • Improve --regex-limit logic [#70]
  • Adapt package for framework v2 [#86]
  • Add --regex-limit option. [#62]

wp-cli/server-command

  • Adapt package for framework v2 [#42]

wp-cli/shell-command

  • Adapt package for framework v2 [#25]
  • Better explain the --basic flag [#23]

wp-cli/widget-command

  • Adapt package for framework v2 [#19]

Contributors

Here’s the complete list of the fantastic folks that have helped make this happen:

@2020media, @abhijitrakas, @ajitbohra, @alpipego, @austinginder, @benlk, @BhargavBhandari90, @burhandodhy, @chesio, @CodeProKid, @danielbachhuber, @drzraf, @emirpprime, @ericgopak, @erlendeide, @felicianotech, @felipeelia, @fumikito, @GaryJones, @ghost, @gitlost, @greatislander, @JanVoracek, @janw-oostendorp, @javorszky, @jblz, @jmichaelward, @johnbillion, @josephfusco, @kirtangajjar, @kshaner, @lalaithan, @lf-jeremy, @libertamohamed, @marcovalloni, @marksabbath, @miya0001, @MoisesMN, @montu1996, @NicktheGeek, @ocean90, @pdaalder, @pekapl, @pixolin, @pjeby, @pmbaldha, @ptrkcsk, @ryanjbonnell, @sagarnasit, @salcode, @sasagar, @schlessera, @spacedmonkey, @spicecadet, @stevegrunwell, @strandtc, @svenkaptein, @swissspidy, @terriann, @thrijith, @tiagohillebrandt, @tomjn, @torounit, @wojsmol, @wp-make-coffee, @yousan, @zipofar

A big thank you to all involved! ❤️

#release, #v2-0-0