PhpStorm 2021.3 Help

WP-CLI 命令行工具

要在命令行模式下运行 WordPress,您将需要一组命令行工具,您可以通过使用 Composer 依赖管理器安装wp-cli/wp-cli包或下载wp-cli.phar存档来获取这些工具。下载的命令行工具必须按照PHP 命令行工具中的说明在 PhpStorm 中注册。

有关在命令行模式下运行该工具的信息,请参阅PHP 命令行工具

在你开始前

使用 Composer 依赖管理器安装 WP-CLI 包

在开始之前,请确保 Composer 已安装在您的计算机上并在当前项目中初始化,如Composer 依赖项管理器中所述。

单击创建。将使用选定的包调用create-project Composer 命令。结果,将创建 Composer 项目,其配置和结构取决于所选包。之后,创建的 PhpStorm 项目将打开。

  1. composer.json中,将wp-cli/wp-cli依赖记录添加到requireorrequire-dev部分。按Ctrl+Space以获得包名称和版本的代码完成。

  2. 执行以下操作之一:

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

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

使用 WP-CLI 作为 PhpStorm 命令行工具

在开始之前,请在WordPress CLI下载wp-cli.phar

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

  1. 设置/首选项对话框 ( Ctrl+Alt+S) 中,转到工具 | 命令行工具支持

  2. 单击添加按钮工具栏上的 。

  3. 命令行工具对话框中,从列表中选择 WP-CLI,并指定其可见性级别(项目全局)。

    命令行工具对话框
  4. 单击OK时,将打开WP-CLI对话框。

    选择运行WP-CLI的方式:

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

      从PHP 解释器列表中选择一种已配置的 PHP 解释器。有关详细信息,请参阅配置本地 PHP 解释器配置远程 PHP 解释器

      Path to phar字段中,指定wp-cli.phar存档的位置。手动键入路径或单击浏览按钮并在打开的对话框中选择所需位置。

    • 可执行文件可用(通过 Composer 等安装):选择此选项可通过可执行文件启动WordPress ,当您使用包管理工具(例如 Composer)安装WordPress时,该文件可用。

      wp.bat 的路径字段中,指定wp.batwp可执行文件的位置。如果您使用 Composer,默认位置是\vendor\wp\cli\bin\wp\vendor\wp\cli\bin\wp.bat。手动键入路径或单击浏览按钮并在打开的对话框中选择所需位置。

  5. 单击确定应用更改并返回命令行工具支持页面。或者,单击编辑按钮以编辑工具属性或编辑源按钮自定义命令集。有关详细信息,请参阅自定义工具

运行 WP-CLI 命令

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

  • 从主菜单中,选择工具 | 运行命令或按Ctrl两次。

    在打开的“运行任何内容”窗口中,以<wp> <command>格式键入命令的调用。

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

    运行 wp-cli 命令

终止命令

调试 WP-CLI 命令

Wordpress 命令在扩展的控制器类WP_CLI_Command以及任意函数中定义。要调试命令,启动命令本身的调试会话至关重要,而不是控制器类或定义它的文件。否则,将跳过 Wordpress 引导过程,执行将失败。

  1. 在与所选命令对应的控制器类或文件中,单击要设置断点的代码行处的编辑器间距。

    在 Wordpress 命令中设置断点
  2. 创建一个运行/调试配置,该配置将使用所选命令运行wp-cli工具。在主菜单中,选择运行 | 编辑配置,然后单击并从列表中添加按钮选择PHP 脚本。

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

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

    • 参数字段中,键入实际命令及其参数,例如my-command print_year.

    Wordpress CLI 命令的运行/调试配置对话框
  4. 在 PhpStorm 工具栏上,选择创建的运行/调试配置并单击调试按钮。命令执行将在指定的断点处停止。

    调试 Wordpress 命令
最后修改时间:2021 年 10 月 20 日