基于 giacocorsiglia/wordpress-stubs 和 paulthewalton/acf-stubs。Timber 函数、类和全局变量声明占位符,以便更容易进行静态分析。
Requires (Dev)
- ext-gettext: *
- composer/composer: ^2.4
- php-stubs/generator: ^0.8.1
- wpackagist-plugin/timber-library: ^1.22
This package is not auto-updated.
Last update: 2024-09-30 03:12:00 UTC
README
此包提供 Timber 核心函数、类、接口和全局变量的占位符。这些占位符可以帮助插件和主题开发者利用静态分析工具。
这些占位符直接从 源代码 使用 giacocorsiglia/stubs-generator 生成。不用说,这个库重新包装了 Timber 代码的一部分,这是 Timber 开发者的作品。诚然,没有真实的东西,这部分是毫无用处的!
非常感谢 GiacoCorsiglia,他在 giacocorsiglia/wordpress-stubs 上做了所有艰苦的工作,这是从该占位符中毫无顾忌地剽窃的,还要感谢 Paul Walton,他创建了 Advanced Custom Fields Stubs,这是此占位符的基础。
安装
使用 Composer 将此包作为开发依赖项要求
composer require --dev baxtian/timber-stubs
或者,您可以直接下载 timber-stubs.php。
Intellisense 使用方法
从 WordPress 占位符
如果您的编辑器在解析所有 WordPress 时遇到困难,您可能会发现这些占位符对于启用代码完成和相关功能很有用。例如,有关使用 VSCode 的 Intelephense 扩展的说明,请参阅 此处。(然而,根据我的经验,Intelephense 可以很好地解析 WordPress 核心代码。)
版本
此包的版本与生成占位符的 ACF 版本相匹配。如果需要修复占位符,后续版本将版本化为 TIMBER_VERSION.X。
为不同版本的 Timber 生成占位符
您应该运行 PHP 8.1 或更高版本,以便遵循这些步骤,因此任何针对较旧 PHP 版本的填充函数定义都将从占位符中排除。此外,占位符生成器包至少需要 PHP 8.1。
- 克隆此存储库并将
cd进入它。 - 将
"wpackagist-plugin/timber-library": "X.X.X"更新为composer.json中的所需版本。 - 运行
composer update - 运行
./generate.sh
现在应更新 timber-stubs.php 文件。如果您想看到针对较新版本的发布,请随时提交拉取请求。如果事情落后了,请为每个缺少的版本在不同的提交中生成占位符,以便我们有一个连续的发布历史记录。