WordPress 的命令行界面

4.0.0 2018-03-20 13:44 UTC

This package is not auto-updated.

Last update: 2024-09-19 12:48:26 UTC


README

EEWordPress 的命令行界面。您可以在不使用网页浏览器的情况下更新插件、配置多站点安装等。

持续维护由 赞助商 支持

当前稳定版本是 1.5.0 版。有关公告,请关注 @wpcli 在 Twitter 上的动态,或 注册电子邮件更新。查看 路线图 以了解即将发布版本的计划概述。

Build Status Dependency Status Average time to resolve an issue Percentage of issues still open

快速链接: 使用 | 安装 | 支持 | 扩展 | 贡献 | 致谢

使用

EE 为您在 WordPress 管理员中可能执行的多项操作提供了命令行界面。例如,wp plugin install --activate文档)允许您安装并激活 WordPress 插件

$ wp plugin install user-switching --activate
Installing User Switching (1.0.9)
Downloading install 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.

EE 还包括许多您在 WordPress 管理员中无法执行的命令。例如,wp transient delete --all文档)允许您删除一个或所有临时数据

$ wp transient delete --all
Success: 34 transients deleted from the database.

要详细了解 EE 的使用方法,请阅读 快速入门指南。或者,您可以阅读 shell 朋友 的文章,了解有用的命令行实用程序。

如果您已经熟悉了基础知识,可以直接查看 命令列表,以获取有关管理主题和插件、导入导出数据、执行数据库搜索替换操作等详细信息。

安装

对于大多数用户,我们推荐使用下载 Phar 文件的方式进行安装。如果您需要,也可以查看我们关于 替代安装方法 的文档。

在安装 EE 之前,请确保您的环境满足最低要求

  • 类 Unix 环境(OS X、Linux、FreeBSD、Cygwin);Windows 环境支持有限
  • PHP 5.3.29 或更高版本
  • WordPress 3.7 或更高版本。比最新 WordPress 版本更早的版本可能功能会受到影响

验证要求后,使用 wgetcurl 下载 ee.phar 文件

curl -O https://raw.githubusercontent.com/ee/builds/gh-pages/phar/ee.phar

接下来,检查 Phar 文件以验证其是否正常工作

php ee.phar --info

要使用 EE,在命令行中输入 wp,请使文件可执行,并将其移动到 PATH 中的某个位置。例如

chmod +x ee.phar
sudo mv ee.phar /usr/local/bin/wp

如果 EE 安装成功,您在运行 wp --info 时应该会看到类似以下内容:

$ wp --info
OS:	Darwin 16.7.0 Darwin Kernel Version 16.7.0: Thu Jan 11 22:59:40 PST 2018; root:xnu-3789.73.8~1/RELEASE_X86_64 x86_64
Shell:	/bin/zsh
PHP binary:    /usr/local/bin/php
PHP version:    7.0.22
php.ini used:   /etc/local/etc/php/7.0/php.ini
EE root dir:        /home/ee/.ee
EE vendor dir:	    /home/ee/.ee/vendor
EE packages dir:    /home/ee/.ee/packages/
EE global config:   /home/ee/.ee/config.yml
EE project config:
EE version: 1.5.0

正在更新

您可以使用 wp cli update 更新 EE(文档),或者重复安装步骤。

如果 EE 由 root 或其他系统用户拥有,您需要运行 sudo wp cli update

想要走在前沿?运行 wp cli update --nightly 来使用 EE 的最新夜间构建。夜间构建足够稳定,足以在您的开发环境中使用,并且始终包含最新的 EE 功能。

Tab 完成功能

EE 还为 Bash 和 ZSH 提供了 tab 完成脚本。只需下载 wp-completion.bash 并从 ~/.bash_profile 中源它。

source /FULL/PATH/TO/wp-completion.bash

别忘了之后运行 source ~/.bash_profile

如果您使用 zsh 作为您的 shell,在源之前可能需要加载并启动 bashcompinit。将以下内容放入您的 .zshrc

autoload bashcompinit
bashcompinit
source /FULL/PATH/TO/wp-completion.bash

支持

EE 的维护者和贡献者有限的时间来回答一般支持问题。EE 的 当前版本 是唯一官方支持版本。

在寻找支持时,请首先在这些场所搜索您的问题

如果您在上面的场所中没有找到答案,您可以

GitHub 问题用于跟踪现有命令的增强和错误,而不是一般支持。在提交错误报告之前,请审查我们的最佳实践,以确保您的问题能够及时得到解决。

请勿在 Twitter 上询问支持问题。Twitter 不是支持的可接受场所,因为:1)在 140 个字符内很难进行对话,2)Twitter 不是一个可以在先前的对话中搜索答案的地方。

记住,libre != gratis;开源许可证赋予您使用和修改的自由,但不承诺其他人的时间。请尊重,并相应地设定您的期望。

扩展

命令 是 EE 功能的原子单位。《code>wp plugin install(《a href="https://developer.wordpress.org/cli/commands/plugin/install/" rel="nofollow noindex noopener external ugc">文档》)是一个命令。《code>wp plugin activate(《a href="https://developer.wordpress.org/cli/commands/plugin/activate/" rel="nofollow noindex noopener external ugc">文档》)是另一个。

EE 支持将任何可调用的类、函数或闭包注册为命令。它从回调的 PHPdoc 中读取使用细节。《code>EE::add_command()(《a href="https://make.wordpress.org/cli/handbook/internal-api/ee-add-command/" rel="nofollow noindex noopener external ugc">文档”)用于内部和第三方命令注册。

/**
 * 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 ) ) {
		EE::error( "Could not delete '$key' option. Does it exist?" );
	} else {
		EE::success( "Deleted '$key' option." );
	}
};
EE::add_command( 'option delete', $delete_option_cmd );

EE 提供了数十个命令。创建自定义 EE 命令比看起来要容易得多。阅读命令食谱以获取更多信息。浏览内部 API 文档以发现您可以在自定义 EE 命令中使用的一系列实用功能。

贡献

我们感谢您积极为 EE 贡献。正是因为您和您周围社区的努力,EE 才成为一个如此出色的项目。

贡献不仅仅限于代码。 我们鼓励您以最适合您能力的方式做出贡献,例如撰写教程、在当地聚会中演示、帮助其他用户解决支持问题或修订我们的文档。

请阅读我们手册中的贡献指南,以详细了解如何参与其中。遵循这些指南有助于传达您尊重项目中其他贡献者的时间。作为回报,他们将在与您合作时尽力回报这种尊重,无论跨越时区还是世界各地的合作。

领导

EE 有两位项目负责人: danielbachhuberschlessera

偶尔,我们会授予有贡献者写入权限,这些贡献者在一段时间内证明了自己有能力并致力于推动项目向前发展。

阅读手册中的治理文档以获取更多关于项目的操作细节。

鸣谢

除了在composer.json中定义的库之外,我们还使用了以下项目的代码或想法: