为 WordPress 从 VS Code 运行 PHPCS - PHP

如果您是使用 WordPress 开发主题或插件的 PHP 开发人员，则可能已经知道 WordPress 官方代码规范。为遵循这一规范并确保您的代码质量，您可以使用 PHP CodeSniffer 。

在本文中，我们将讨论如何通过 VS Code 在 WordPress 中运行 PHPCS。

准备工作

首先，您需要安装以下软件：

• Visual Studio Code
• PHP CodeSniffer
• WordPress-Coding-Standards

以便在本地计算机上执行 PHPCS。

安装与配置

安装 PHPCS

您可以使用以下命令在终端中安装 PHPCS：

composer global require "squizlabs/php_codesniffer=*" 

安装 WordPress-Coding-Standards

在安装 WordPress-Coding-Standards 之前，您需要安装 Composer 。

首先，请使用以下命令：

composer global require "dealerdirect/phpcodesniffer-composer-installer" 

该命令将自动将 WordPress-Coding-Standards 安装到您的 PHP CodeSniffer 中。

配置 VS Code

VS Code 中的 settings.json 文件是用于配置 PHPCS 的最佳方法。通过在 settings.json 文件中添加以下内容，您可以轻松配置 PHPCS：

"phpcs.standard": "WordPress",
"phpcs.executablePath": "~/.composer/vendor/bin/phpcs",
"phpcs.showErrorOnMissing": "true",
"phpcs.showWarnings": "true",
"phpcs.ignoreWarnings": "false",
"php.validate.executablePath": "~/.composer/vendor/bin/php",

使用 PHPCS

现在，您已经在本地计算机上成功安装和配置了 PHPCS，并且现在可以在 VS Code 中使用它来检查您的 WordPress 主题或插件。

首先，请打开您的 WordPress 主题或插件所在的文件夹（使用 “文件” -- > “打开文件夹” ）。

接下来，打开您在 settings.json 文件中定义的终端并键入以下命令：

phpcs --standard=WordPress .

该命令将检查当前文件夹中的所有文件并返回任何 PhPCS 错误。

如果您正在运行较旧版本的 PHP CodeSniffer，则可能会遇到以下错误：

1. ERROR | This version of WordPress-Extra has been superseded
2. ERROR | This version of WordPress-Docs has been superseded 

如果出现此错误，请使用以下命令安装最新版本的 WordPress-Coding-Standards：

composer global update 

再次运行 phpcs --standard=WordPress . 命令，即可解决该错误。

结论

通过本文介绍，您已经了解了如何在 WordPress 中使用 PHP CodeSniffer。这将帮助您遵循 WordPress 官方代码规范并遵循最佳实践编写优质代码。