idearia / wp-cli-command
一个简单的类,用于通过少量努力创建带验证的 WP-CLI 命令。
2.0
2023-10-18 14:49 UTC
Requires
- php: ^8.1
Requires (Dev)
- php-stubs/wp-cli-stubs: ^2.7
- phpstan/phpstan: ^1.9
README
一个简单的类,用于通过少量努力创建带验证的 WP-CLI 命令。
功能
- 通过扩展简单类创建 WP CLI 命令
- 通过扩展方法
before_run_command、before_invoke和after_invoke容易地挂钩到 命令生命周期 - 通过扩展方法
validate进行高级验证 - 通过定义公共方法支持子命令
- 支持 PHPDoc 验证
快速入门
- 在您的项目中要求
wp-cli-commandcomposer require idearia/wp-cli-command - 通过扩展
Command类创建一个新命令。如何?看看 示例文件夹 🙂 - 通过
MyCommand::init( 'my-command' );注册您的命令 - 使用
wp my-command运行命令。
可用钩子
执行顺序
before_run_command> 在命令被找到和执行之前before_invoke> 在调用命令之前after_invoke> 在调用命令之后
示例
- 来自 WP-CLI 文档 的一个简单命令,具有额外的验证层: examples/SimpleCommand.php
- 具有两个子命令的示例,每个子命令都有自己的验证 > TODO!
待办事项
- 使钩子方法了解正在执行的具体命令,如果类中包含多个命令。可能需要从静态切换,以便在类中保存 $args。
- 使用
wp scaffold package的 Behat 测试 - 子命令示例
- 找到一种方法在自定义验证之前执行 PHPDoc 验证(可能通过调用命令并使用
before_invoke:{$cmd}退出)? - 找到一种方法打印实际的用法,而不是依赖 $usage 属性(如何在 subcommand.php 中强制显示_usage)?