使用 vscode
来开发 wordpress
项目,发现两个需要配置的问题。
代码标准问题
我使用的全局 PHP
代码标准是:
"phpsab.standard": "PSR2",
这个代码标准是不适用于 wordpress
项目的,会导致全屏到处是红色格式错误的提示。
针对这个问题,我们需要使用 composer
安装一下 wordpress
标准:
必要条件:Composer v2.x
composer require --dev wp-coding-standards/wpcs:"^3.0"
正确安装之后,可以运行一下 phpcs
确认当前已安装的代码标准中已经存在 WordPress
:
PS C:\laragon\composer> .\vendor\bin\phpcs -i
The installed coding standards are MySource, PEAR, PSR1, PSR2, PSR12, Squiz, Zend, Modernize, NormalizedArrays, Universal, PHPCSUtils, WordPress, WordPress-Core, WordPress-Docs and WordPress-Extra
可以看到,已安装的代码标准已经包含了 WordPress
,表示正确安装没问题。
然后,在项目的 .vscode
目录下的 settings.json
下设置代码标准:
{
"phpsab.standard": "WordPress"
}
重新打开项目,发现代码错误提示都消失了,至于这里的 phpcs
如何安装使用的,可以参考文章:vscode配置PHP代码检查和格式化工具PHP Sniffer & Beautifier
wordpress
函数环境提示
这个情况出现在 vscode
工作区是某个插件或某个主题,而不是整个 wordpress
项目时,因为项目中不包含 wordpress
框架代码,只有主题或插件代码,那代码中的 wordpress
相关函数/变量会提示未定义,需要在 setting.json
中添加两个配置:
必要条件:PHP Intelephense
插件
{
"php.validate.executablePath": "[修改为php.exe文件路径]",
"php.executablePath": "[修改为php.exe文件路径]",
"intelephense.environment.includePaths": [
"[修改为wordpress项目根目录路径]",
]
}