axepress / wp-graphql-stubs
为静态分析提供 WPGraphQL 函数和类声明占位符。
v1.29.0
2024-09-20 01:43 UTC
Requires
- php-stubs/wordpress-stubs: ^5.4 || ^6.0
Requires (Dev)
- php: >=7.3
- php-stubs/generator: ^0.8.0
- phpstan/phpstan: ^1.8
Suggests
- szepeviktor/phpstan-wordpress: WordPress extensions for PHPStan
- dev-main
- v1.29.0
- v1.28.1
- v1.28.0
- v1.27.1
- v1.27.0
- v1.26.0
- v1.25.0
- v1.24.0
- v1.23.0
- v1.22.1
- v1.22.0
- v1.21.0
- v1.20.0
- v1.19.0
- v1.18.2
- v1.18.1
- v1.17.0
- v1.16.0+repack.1
- v1.15.0+repack.1
- v1.14.10+repack.1
- v1.14.9+repack.1
- v1.14.8+repack.1
- v1.14.7+repack.1
- v1.14.6+repack.1
- v1.14.5+repack.1
- v1.14.4+repack.1
- v1.14.3+repack.1
- v1.14.2+repack.1
- v1.14.0+repack.1
- v1.13.10+repack.1
- v1.13.9+repack.1
- v1.13.8+repack.1
- v1.13.7+repack.1
- v1.13.6+repack.1
- v1.13.5+repack.1
- v1.13.4+repack.1
- v1.13.2+repack.1
- v1.13.1+repack.1
- v1.13.0+repack.1
- v1.12.3+repack.1
- v1.12.2+repack.1
- v1.12.1+repack.1
- v1.12.0+repack.1
- v1.11.3+repack.1
- v1.11.2+repack.1
- v1.11.1+repack.1
- v1.11.0+repack.1
- v1.10.0+repack.1
- v1.9.1+repack.1
- v1.9.0+repack.1
- v1.8.7+repack.1
- v1.8.6+repack.1
- v1.8.5+repack.1
- v1.8.4+repack.1
- v1.8.3+repack.1
- v1.8.2+repack.1
- v1.8.1+repack.1
- v1.8.0+repack.1
- v1.7.2+repack.1
- v1.7.1+repack.1
- v1.7.0+repack.1
- v1.6.12+repack.1
- v1.6.11+repack.1
- v1.6.10+repack.1
- v1.6.9+repack.1
- v1.6.8+repack.1
- v1.6.7+repack.1
- v1.6.6+repack.1
- v1.6.5+repack.1
- v1.6.4+repack.1
- v1.6.3+repack.1
- v1.6.2+repack.1
- v1.6.1+repack.1
- v1.6.0+repack.1
- v1.5.9+repack.1
- v1.5.8+repack.1
- v1.5.7+repack.1
- v1.5.6+repack.1
- v1.5.5+repack.1
- v1.5.4+repack.1
- v1.5.3+repack.1
- v1.5.2+repack.1
- v1.5.1+repack.1
- v1.5.0+repack.1
- v1.4.3+repack.1
- v1.4.2+repack.1
- v1.4.1+repack.1
- v1.4.0+repack.1
- v1.3.10+repack.1
- v1.3.9+repack.1
- v1.3.8+repack.1
- v1.3.7+repack.1
- v1.3.6+repack.1
- v1.3.5+repack.1
- v1.3.4+repack.1
- v1.3.3+repack.1
- v1.3.2+repack.1
- v1.3.1+repack.1
- v1.3.0+repack.1
- v1.2.6+repack.1
- v1.2.5+repack.1
- v1.2.4+repack.1
- v1.2.3+repack.1
- v1.2.1+repack.1
- v1.2.0+repack.1
- v1.1.8+repack.1
- v1.1.7+repack.1
- v1.1.6+repack.1
- v1.1.5+repack.1
- v1.1.4+repack.1
- v1.1.3+repack.1
- v1.1.2+repack.1
- v1.1.1+repack.1
- v1.1.0+repack.1
- v1.0.5+repack.1
- v1.0.4+repack.1
- v1.0.3+repack.1
- v1.0.2+repack.1
- v1.0.1+repack.1
This package is auto-updated.
Last update: 2024-09-20 01:44:13 UTC
README
为 WPGraphQL 核心函数、类和接口提供占位符声明。这些占位符可以帮助插件和主题开发者利用静态分析工具,如 PHPStan。
占位符是用 php-stubs/generator 生成的。
要求
- PHP 7.3+
- Sodium PHP 扩展,因为最新版本的 WordPress 核心使用它,并且从占位符中移除了兼容代码。
安装
使用 Composer 将此包作为开发依赖项要求。
composer require --dev axepress/wp-graphql-stubs
或者您可以直接下载 wp-graphql-stubs.php
。
与 PHPStan 一起使用
composer require --dev szepeviktor/phpstan-wordpress axepress/wp-graphql-stubs
包 szepeviktor/phpstan-wordpress
依赖于 phpstan/phpstan
。请务必阅读那个包的 README,并查看那里的 example
目录。
版本控制
此包的版本与生成的占位符所依据的 WPGraphQL 版本相匹配。
当对实际的占位符生成进行更改并需要新的发布版本时,旧版本将被 删除,并创建一个格式为 x.x.x+repack.y
的新标签,其中 x.x.x
是 WPGraphQL 版本,y
是重新打包迭代。这是必要的,因为 Composer 的 SemVer 实现在确定最新版本时忽略了构建元数据。
如果您已经安装了旧版本的构建,您需要运行 composer update --no-cache
以获取最新的重新打包。
为不同的 WPGraphQL 版本生成占位符
- 克隆此存储库并
cd
进入。 - 在
composer.json
中将"wpackagist-plugin/wp-graphql": "x.x.x"
更新为所需的版本 - 运行
composer update
- 运行
composer generate
现在 wp-graphql-stubs.php
文件应该已更新。
先验技术
- 基于 php-stubs/woocommerce-stubs。
- 受到原始 wp-graphql-stubs 项目的启发。