WP-CLI 是 WordPress 的命令行界面。您可以更新插件、配置多站点安装等等,而无需使用 Web 浏览器。
通过以下方式可以进行持续维护:
当前的稳定版本是版本 2.11.0。如需公告,请在 Twitter 上关注 @wpcli 或注册电子邮件更新。查看路线图,了解即将发布的版本的计划概述。
快速链接:使用|安装|支持|延伸|贡献 |制作人员
WP-CLI 为您可能在 WordPress 管理员中执行的许多操作提供了命令行界面。例如, wp plugin install --activate
(doc) 可让您安装并激活 WordPress 插件:
$ wp plugin install user-switching --activate
Installing User Switching (1.0.9)
Downloading installation package from https://downloads.wordpress.org/plugin/user-switching.1.0.9.zip...
Unpacking the package...
Installing the plugin...
Plugin installed successfully.
Activating ' user-switching ' ...
Plugin ' user-switching ' activated.
Success: Installed 1 of 1 plugins.
WP-CLI 还包含许多在 WordPress 管理员中无法执行的操作的命令。例如, wp transient delete --all
(doc)可让您删除一个或所有瞬态:
$ wp transient delete --all
Success: 34 transients deleted from the database.
有关使用 WP-CLI 的更完整介绍,请阅读快速入门指南。或者,与 shell 朋友联系以了解有用的命令行实用程序。
已经对基础知识感到满意了吗?跳转到完整的命令列表,了解有关管理主题和插件、导入和导出数据、执行数据库搜索替换操作等的详细信息。
下载 Phar 文件是我们推荐大多数用户的安装方法。如果您需要,另请参阅我们有关替代安装方法(Composer、Homebrew、Docker)的文档。
在安装 WP-CLI 之前,请确保您的环境满足最低要求:
验证要求后,使用wget
或curl
下载 wp-cli.phar 文件:
curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar
接下来,检查 Phar 文件以验证其是否正常工作:
php wp-cli.phar --info
要通过键入wp
从命令行使用 WP-CLI,请使文件可执行并将其移动到 PATH 中的某个位置。例如:
chmod +x wp-cli.phar
sudo mv wp-cli.phar /usr/local/bin/wp
如果 WP-CLI 安装成功,当您运行wp --info
时,您应该会看到类似以下内容:
$ wp --info
OS: Linux 5.10.60.1-microsoft-standard-WSL2 # 1 SMP Wed Aug 25 23:20:18 UTC 2021 x86_64
Shell: /usr/bin/zsh
PHP binary: /usr/bin/php8.1
PHP version: 8.1.0
php.ini used: /etc/php/8.1/cli/php.ini
MySQL binary: /usr/bin/mysql
MySQL version: mysql Ver 8.0.27-0ubuntu0.20.04.1 for Linux on x86_64 (( Ubuntu ))
SQL modes:
WP-CLI root dir: /home/wp-cli/
WP-CLI vendor dir: /home/wp-cli/vendor
WP_CLI phar path:
WP-CLI packages dir: /home/wp-cli/.wp-cli/packages/
WP-CLI global config:
WP-CLI project config: /home/wp-cli/wp-cli.yml
WP-CLI version: 2.11.0
您可以使用wp cli update
(doc) 或重复安装步骤来更新 WP-CLI。
如果 WP-CLI 由 root 或其他系统用户拥有,您需要运行sudo wp cli update
。
想要过着边缘生活吗?运行wp cli update --nightly
以使用 WP-CLI 的最新每晚版本。每晚构建或多或少足够稳定,足以让您在开发环境中使用,并且始终包含最新和最好的 WP-CLI 功能。
WP-CLI 还附带了适用于 Bash 和 ZSH 的制表符补全脚本。只需下载 wp-completion.bash 并从~/.bash_profile
获取它:
source /FULL/PATH/TO/wp-completion.bash
不要忘记之后运行source ~/.bash_profile
。
如果您的 shell 使用 zsh,您可能需要在采购之前加载并启动bashcompinit
。将以下内容放入您的.zshrc
中:
autoload bashcompinit
bashcompinit
source /FULL/PATH/TO/wp-completion.bash
WP-CLI 的维护者和贡献者解决一般支持问题的时间有限。当前版本的 WP-CLI 是唯一官方支持的版本。
寻求支持时,请首先在以下场所搜索您的问题:
如果您在上述任一地点没有找到答案,您可以:
#cli
频道,与当时有空的任何人聊天。此选项最适合快速提问。GitHub 问题旨在跟踪现有命令的增强功能和错误,而不是一般支持。在提交错误报告之前,请查看我们的最佳实践,以帮助确保您的问题得到及时解决。
请不要在 Twitter 上询问支持问题。 Twitter 不是一个可接受的支持场所,因为:1) 很难在 280 个字符以下进行对话,2) Twitter 不是一个可以让有相同问题的人在之前的对话中搜索答案的地方。
请记住,自由!=免费;开源许可证授予您使用和修改的自由,但不承诺占用其他人的时间。请保持尊重,并相应地设定您的期望。
命令是 WP-CLI 功能的原子单元。 wp plugin install
(doc)是一个命令。 wp plugin activate
(doc)是另一个。
WP-CLI 支持将任何可调用类、函数或闭包注册为命令。它从回调的 PHPdoc 中读取使用详细信息。 WP_CLI::add_command()
(doc) 用于内部和第三方命令注册。
/**
* Delete an option from the database.
*
* Returns an error if the option didn't exist.
*
* ## OPTIONS
*
* <key>
* : Key for the option.
*
* ## EXAMPLES
*
* $ wp option delete my_option
* Success: Deleted 'my_option' option.
*/
$ delete_option_cmd = function ( $ args ) {
list ( $ key ) = $ args ;
if ( ! delete_option ( $ key ) ) {
WP_CLI :: error ( " Could not delete ' $ key ' option. Does it exist? " );
} else {
WP_CLI :: success ( " Deleted ' $ key ' option. " );
}
};
WP_CLI :: add_command ( ' option delete ' , $ delete_option_cmd );
WP-CLI 附带了数十个命令。创建自定义 WP-CLI 命令比看起来更容易。阅读命令手册以了解更多信息。浏览内部 API 文档以发现可在自定义 WP-CLI 命令中使用的各种有用功能。
我们感谢您主动为 WP-CLI 做出贡献。正是因为您和您周围的社区,WP-CLI 才成为一个如此伟大的项目。
贡献不仅仅限于代码。我们鼓励您以最适合您能力的方式做出贡献,例如编写教程、在本地聚会上进行演示、帮助其他用户解决支持问题或修改我们的文档。
仔细阅读手册中的贡献指南,了解如何参与的全面介绍。遵循这些准则有助于传达您尊重项目其他贡献者的时间。反过来,他们会在跨越时区和世界各地与您合作时尽最大努力回报您的尊重。
WP-CLI 有一位项目维护者:schlessera。
有时,我们会向在一段时间内证明自己有能力并投入推动项目前进的贡献者授予写入权限。
请阅读手册中的治理文档,了解有关该项目的更多操作细节。
除了composer.json中定义的库之外,我们还使用了以下项目的代码或想法:
wp shell
wp media regenerate
的缩略图wp search-replace
的搜索替换数据库wp export
的 WordPress-CLI-Exporterwp import
的导入器wp scaffold plugin-tests