从 PhpStorm 使用 WP-CLI 命令行工具

使用 Composer 安装 WP-CLI 包

1. 在 composer.json 中，将 wp-cli/wp-cli 依赖项记录添加到 require 或 require-dev 键中。 要获取包名称和版本的代码补全，请按 Ctrl+Space。

2. 请执行以下操作之一：

   • 单击编辑器面板顶部的 安装 快捷链接。

   • 如果启用了 未安装的 Composer 包 检查，PhpStorm 将突出显示当前未安装的声明依赖项。 按 Alt+Enter 并选择是要安装特定依赖项还是一次性安装所有依赖项。

将 WP-CLI 配置为命令行工具

1. 在 设置 对话框 (Ctrl+Alt+S) 中，前往 工具 | PHP 命令行工具支持。

2. 点击 工具栏。

3. 在 命令行工具 对话框中，从列表中选择 WP-CLI ，并指定其可见性级别（Project 或 全局）。

   

4. 当您单击 确定 时，将打开 WP-CLI 对话框。

   选择运行 WP-CLI 的方式：

   • 通过 PHAR 安装： 选择此选项通过 PHP 脚本启动 WordPress ，或者让 PhpStorm 检测并启动 wp-cli.phar 存档中的启动器。

     从 PHP 解释器 列表中选择一个已配置的 PHP 解释器。 如需更多信息，请参阅 配置本地 PHP 解释器 和 配置远程 PHP 解释器。

     在 phar 的路径 字段中指定 wp-cli.phar 存档的位置。 手动输入路径或单击 ，然后在打开的对话框中选择所需的位置。

   • 可用的可执行文件（通过 Composer 等安装）： 选择此选项通过可执行文件启动 WordPress ，该文件在您使用包管理工具（例如 Composer）安装 WordPress 时可用。

     在 wp.bat 的路径 字段中指定 wp.bat 或 wp 可执行文件的位置。 如果您使用了 Composer，默认位置是 \vendor\wp\cli\bin\wp 或 \vendor\wp\cli\bin\wp.bat 。 手动输入路径或单击 ，然后在打开的对话框中选择所需的位置。

5. 单击 确定 以应用更改并返回到 PHP 命令行工具支持 页面。 可选地，单击 以编辑工具属性，或单击 以自定义命令集。 欲了解更多信息，请参阅 自定义工具。

运行 WP-CLI 命令

您可以运行 WP-CLI 命令并直接在 PhpStorm 中分析其输出，就像任何其他命令行工具的命令一样，请参阅 PHP 命令行工具。

• 转到 工具 | 运行命令 或按两次 Ctrl。

  在打开的 运行任意内容 窗口中，以 <wp> <command> 格式输入命令调用。

  命令执行结果显示在 运行工具窗口 中。

  

终止命令

• 单击 位于 运行工具窗口 工具栏上。

调试 WP-CLI 命令

Wordpress 命令定义在扩展 WP_CLI_Command 的控制器类中，也可以定义在任意函数中。 要调试命令，关键是您必须为命令本身启动调试会话，而不是为定义命令的控制器类或文件启动调试会话。 否则，Wordpress 的引导过程将被跳过，执行将失败。

1. 在控制器类或与所选命令对应的文件中，单击代码行的编辑器边栏以设置 断点。

   

2. 创建一个 运行/调试配置 ，以使用所选命令运行 wp-cli 工具。 在主菜单中，转到 运行 | 编辑配置 ，然后单击 并从列表中选择 PHP 脚本。

   

3. 在 PHP 脚本 对话框中，提供运行/调试配置参数。

   • 在 File 字段中，提供 wp-cli 可执行文件的路径。

   • 在 参数 字段中，输入实际命令及其参数，例如 my-command print_year。

   

4. 在 PhpStorm 工具栏上，选择创建的运行/调试配置并单击 。 命令执行将在指定的断点处停止。