WordPress Stubs 项目使用教程

WordPress Stubs 项目使用教程

wordpress-stubs Up-to-date WordPress function and class declaration stubs for static analysis by PHPStan 项目地址: https://gitcode.com/gh_mirrors/wo/wordpress-stubs

1. 项目介绍

WordPress Stubs 是一个开源项目，旨在为 WordPress 核心函数、类和接口提供最新的声明存根（stubs）。这些存根可以帮助插件和主题开发者利用静态分析工具（如 PHPStan）进行代码分析。存根不包含全局变量，仅包含函数、类和接口的声明。

该项目由 php-stubs 组织维护，主要贡献者是 Viktor。存根是通过 @johnpbloch 的包使用 php-stubs/generator 生成的。

2. 项目快速启动

2.1 安装

你可以通过 Composer 将此包作为开发依赖项安装：

composer require --dev php-stubs/wordpress-stubs

或者，你可以直接下载 wordpress-stubs.php 文件。

2.2 使用 PHPStan

要与 PHPStan 一起使用，请安装 szepeviktor/phpstan-wordpress 包：

composer require --dev szepeviktor/phpstan-wordpress

然后，确保在 PHPStan 配置中包含 wordpress-stubs.php 文件。

2.3 使用 Psalm

在 Psalm 配置中添加以下部分：

<stubs>
    <file name="vendor/php-stubs/wordpress-stubs/wordpress-stubs.php" />
</stubs>

同时，确保 WordPress 核心不包含在 <projectFiles> 中。

2.4 使用 Intellisense

如果你的 IDE 在解析 WordPress 时遇到问题，可以使用这些存根来启用代码补全和其他相关功能。例如，VSCode 的 Intelephense 扩展有相关的使用说明。

3. 应用案例和最佳实践

3.1 插件开发

在开发 WordPress 插件时，使用 WordPress Stubs 可以帮助你更好地进行静态代码分析，确保代码质量和安全性。通过 PHPStan 或 Psalm 等工具，可以提前发现潜在的错误和问题。

3.2 主题开发

在主题开发中，存根同样可以帮助你进行代码分析，确保主题代码的正确性和一致性。特别是在处理复杂的主题逻辑时，静态分析工具可以提供有价值的反馈。

3.3 最佳实践

• 定期更新存根：由于 WordPress 核心不断更新，建议定期更新存根以确保与最新版本的 WordPress 兼容。
• 结合其他工具：除了 PHPStan 和 Psalm，还可以结合其他静态分析工具（如 Phan）来进一步提升代码质量。

4. 典型生态项目

4.1 phpstan/phpstan

phpstan/phpstan 是一个强大的静态分析工具，可以帮助你发现代码中的错误和潜在问题。结合 WordPress Stubs，可以更好地分析 WordPress 插件和主题代码。

4.2 vimeo/psalm

vimeo/psalm 是另一个流行的静态分析工具，专注于类型检查和代码质量分析。通过使用 WordPress Stubs，可以进一步提升 Psalm 在 WordPress 项目中的效果。

4.3 johnpbloch/wordpress

johnpbloch/wordpress 是一个 Composer 包，用于管理 WordPress 核心文件。WordPress Stubs 的存根是通过这个包生成的，因此它们之间有紧密的联系。

通过这些生态项目的结合使用，可以构建一个强大的开发环境，提升 WordPress 项目的开发效率和代码质量。

wordpress-stubs Up-to-date WordPress function and class declaration stubs for static analysis by PHPStan 项目地址: https://gitcode.com/gh_mirrors/wo/wordpress-stubs