php-stubs/wordpress-stubs

用于静态分析的 WordPress 函数和类声明占位符。

v6.6.0 2024-07-17 08:50 UTC

This package is auto-updated.

Last update: 2024-09-17 23:24:58 UTC


README

重要

大家好!我是 Viktor,管理 php-stubs 组织。我计划停止为 WordPress 生态系统做出贡献,因为这非常困难,并且我每月(至少)赚不到 100 欧元。

请支持我的工作,以免放弃这个包。

Sponsor

谢谢!

WordPress Stubs

Packagist stats Packagist Build Status

它为 WordPress 核心函数、类和接口提供占位符声明,不包括全局变量。这些占位符可以帮助插件和主题开发者利用静态分析工具,如 PHPStan

占位符是从 @johnpbloch 的包 使用 php-stubs/generator 生成的。

要求

  • PHP 7.4 或 8.0

安装

使用 Composer 将此包作为开发依赖项。

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

或者您可以直接下载 wordpress-stubs.php

与 PHPStan 一起使用

composer require --dev szepeviktor/phpstan-wordpress

szepeviktor/phpstan-wordpress 依赖于 phpstan/phpstan 和此包。请务必阅读该包的 README 并查看那里的 example 目录。

与 Psalm 一起使用

更新您的 Psalm 配置以包含此部分。

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

此外,确保 WordPress 核心不包括在 <projectFiles> 中。

在 Intellisense 中使用

如果您的 IDE 难以解析整个 WordPress,您可能会发现这些占位符对于启用代码补全和相关功能很有用。例如,有关于如何使用 VSCode 的 Intelephense 扩展的说明

版本控制

此包的版本与生成占位符的 WordPress 版本相匹配。

为不同版本的 WordPress 生成占位符

  1. 运行现代 PHP 版本
  2. 克隆此存储库并 cd 进入它
  3. source/composer.json 中将 "johnpbloch/wordpress": "x.x.x" 更新为所需版本
  4. 运行 composer update
  5. 然后运行 ./generate.sh

现在 wordpress-stubs.php 文件应该已更新。