baxtian/woocommerce-stubs

基于 giacocorsiglia/wordpress-stubs 和 paulthewalton/acf-stubs。为 WooCommerce 函数、类和全局变量声明提供占位符,以便更容易进行静态分析。

7.8.0 2023-06-24 19:30 UTC

This package is not auto-updated.

Last update: 2024-09-30 00:23:12 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。

  1. 克隆此存储库并 cd 进入它。
  2. composer.json 中将 "wpackagist-plugin/timber-library": "X.X.X" 更新为您想要的版本。
  3. 运行 composer update
  4. 运行 ./generate.sh

现在应该更新了 timber-stubs.php 文件。如果您想看到针对较新版本的发布,请随时提交 Pull Request。如果事情落后了,请将缺失的每个版本分别提交为不同的提交,以便我们有一个连续的发布历史。