PhpStorm 2021.3 Help

WordPress特定的编码帮助

PhpStorm 为开发WordPress提供了完整的编码帮助,包括WordPress感知代码完成、搜索钩子注册函数和指定为钩子注册参数的函数、钩子注册和钩子调用之间的导航、回调、根据WordPress代码风格,从 PhpStorm 编辑器查看WordPress官方文档等。

将 WordPress 添加到项目中

要利用 PhpStorm 提供的编码帮助,您正在使用的WordPress安装应在项目中配置为外部库。因此,WordPress核心文件将参与索引,这是解析引用并提供代码完成、导航、搜索等的基础。

如果wp-content文件夹在WordPress安装之外,则需要将其添加为包含路径内容根目录

将 WordPress 安装配置为项目包含路径

要将WordPress作为外部库添加到您的项目中,您需要将其添加到包含路径列表中。在配置包含路径中了解更多信息。

  1. Settings/Preferences对话框 ( Ctrl+Alt+S) 中,导航到PHP

  2. 在打开的PHP页面上,将WordPress安装文件夹的路径添加到包含路径列表中:单击添加按钮按钮并在打开的对话框中指定安装文件夹的路径。

将 wp-content 文件夹添加到项目中

如果wp-content文件夹位于WordPress安装之外,则除了WordPress核心文件之外,您需要将其单独添加到项目中。这可以通过两种方式完成:

  • 要让wp-content文件夹参与索引而不将其置于项目版本控制之下,请将其添加到包含路径列表中:

    1. Settings/Preferences对话框 ( Ctrl+Alt+S) 中,导航到PHP

    2. 在打开的PHP页面上,将wp-content文件夹的路径添加到Include Paths列表中:单击添加按钮按钮并在打开的对话框中指定文件夹的路径。

  • 要让wp-content文件夹参与索引并将其置于项目版本控制之下,请将其添加为内容根目录

    1. Settings/Preferences对话框 ( Ctrl+Alt+S) 中,导航到Directories

    2. 在打开的目录页面上,单击添加内容根按钮添加按钮

    3. 打开的对话框中,找到wp-content目录并单击OK

    在配置内容根中了解有关配置内容根的更多信息。有关将文件和文件夹添加到版本控制的信息,请参阅启用版本控制

配置 WordPress 代码样式

在 PhpStorm 中,您可以使用符合WordPress 编码标准的WordPress 代码样式在配置代码样式中了解更多信息。

激活WordPress集成后,PhpStorm 会显示一个弹出窗口,让您设置WordPress代码样式。单击弹出窗口中的Set it链接,然后在Code Style 上设置代码样式。打开的PHP页面。

手动设置WordPress代码样式:

    1. Settings/Preferences对话框 ( Ctrl+Alt+S) 中,转到Editor | 代码风格 | PHP

    2. 关于代码风格。打开的PHP 页面,单击Set from...链接。

    3. 从上下文菜单中,选择Predefined Style,然后选择WordPress

根据 Wordpress 编码标准检查代码

使用 PhpStorm,您可以使用检测编码标准问题的PHP_CodeSniffer工具与WordPress Coding Standards结合使用,后者为 PHP_CodeSniffer 提供了一组特定于 Wordpress 的标准。这将确保您的代码干净、一致并且没有一些常见错误。

要开始使用,请使用安装和配置 PHP_CodeSniffer 中描述的任何技术安装 PHP_CodeSniffer。可能最简单的方法是使用Composer安装它。

安装 PHP_CodeSniffer

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

  2. 执行以下操作之一:

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

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

接下来,安装WordPress Coding Standards,它将为 PHP_CodeSniffer 提供特定于 Wordpress 的标准。

安装 WordPress 编码标准

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

  2. 执行以下操作之一:

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

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

将安装WordPress 编码标准包,并自动选择相应的Wordpress标准进行PHP_CodeSniffer 验证检查。如有必要,您可以进一步自定义编辑器上的检查 | 设置/首选项对话框 ( Ctrl+Alt+S)的检查页面。有关详细信息,请参阅将 PHP_CodeSniffer 配置为 PhpStorm 检查

挂钩支持

PhpStorm 索引在WordPress 核心和包含的插件中声明的所有钩子。这为使用钩子时的编码帮助奠定了基础。

完成 Action 和 Filter 函数的参数

钩子名称可用于操作和过滤函数的标准参数的代码完成,add_action()以及add_filter().

为参数调用完成

  1. 开始输入add_action()oradd_filter()函数的声明。

  2. Ctrl+Space并从列表中选择相关参数。

    ps_wp_hooks_completion.png

您可以从挂钩注册(add_action()add_filter()函数)导航到挂钩调用。

挂钩注册的回调

您可以导航到指定为挂钩注册(add_action()add_filter()函数)的第二个参数的函数或方法的声明。

  • Ctrl按下键,将光标悬停在感兴趣的参数上。PhpStorm 显示一个弹出信息消息,其中包含指定为此参数的函数或方法的定义:

    ps_wp_hooks_callback.png

    参数变成一个链接。当您单击此链接时,PhpStorm 会打开声明函数或方法的文件并定位光标和声明。

在文件中的查找和替换文本源代码导航中了解有关搜索和导航的更多信息。

搜索钩子调用并导航到它

执行以下操作之一:

  • 使用导航到符号功能:

    1. 选择导航 | 主菜单中的符号

    2. 在出现的输入符号名称弹出窗口中,开始在搜索字段中输入挂钩名称。如有必要,请选中包括非项目项目复选框。搜索字段下方的列表内容会随着您的键入而改变。

      导航到符号
    3. 单击列表中的相关挂钩。PhpStorm 打开调用它的文件并将光标定位在调用处。

  • 使用Search Everywhere功能:

    1. Shift两次。

    2. 开始在搜索字段中输入挂钩名称。如有必要,请选中包括非项目项目复选框。搜索字段下方的列表内容会随着您的键入而改变。

    3. 单击列表中的相关挂钩。PhpStorm 打开调用它的文件并将光标定位在调用处。

搜索钩子注册函数

您可以搜索挂钩注册函数的出现以及指定为挂钩注册的第二个参数的函数或方法的出现。

在搜索用法中了解更多信息

列出钩子注册函数的用法

  1. 将插入符号放在所需挂钩注册函数的名称处,然后按Alt+F7或选择编辑 | 查找 | 从主菜单中查找用法。

  2. 从显示挂钩/函数名称方面的可用选项的弹出列表中,选择相关选项。查找工具窗口将打开一个新选项卡,显示所有检测到的所选函数的出现。

  3. 探索列出的事件。要导航到相关的,请单击它。PhpStorm 使用选定的函数或方法打开文件并将光标定位在它上面。

列出指定为挂钩注册的第二个参数的函数或方法的出现次数

  1. 将插入符号放置在感兴趣的参数上,然后按Alt+F7或选择编辑 | 查找 | 从主菜单中查找用法。查找工具窗口将打开一个新选项卡,显示所有检测到的函数或方法的出现,该函数或方法指定为调用搜索的参数。

  2. 探索列出的事件。要导航到相关的,请单击它。PhpStorm 使用选定的函数或方法打开文件并将光标定位在它上面。

从 PhpStorm 查看官方 WordPress 文档

您可以直接通过 PhpStorm 编辑器在http://wordpress.org/查看官方WordPress 文档。

  1. 选择您感兴趣的文本。

  2. 从所选内容的上下文菜单中,选择Search on WordPress.org

    PhpStorm 在默认浏览器中打开包含相关文档的页面。

最后修改:2021 年 12 月 10 日