paulthewalton/acf-stubs

此包已被弃用且不再维护。作者建议使用 php-stubs/acf-pro-stubs 包。

基于 giacocorsiglia/wordpress-stubs。为高级自定义字段(ACF)函数、类和全局变量声明提供占位符,以便更容易进行静态分析。

5.8.7 2019-12-04 19:26 UTC

This package is auto-updated.

Last update: 2022-12-04 06:30:50 UTC


README

此项目已被弃用。我建议使用 php-stubs/acf-pro-stubs,因为它更新得更多,并且是活跃维护的。



WordPress 高级自定义字段占位符

No Maintenance Intended

此包为 Wordpress 高级自定义字段 (ACF) 核心函数、类、接口和全局变量提供占位符声明。这些占位符可以帮助插件和主题开发者利用静态分析工具。

占位符直接从 源代码 使用 giacocorsiglia/stubs-generator 生成。不用说,这个库重新打包了 WordPress ACF 代码的一部分,这是 WordPress 核心ACF 开发者的作品。当然,没有真实的东西,这部分是毫无用处的!

非常感谢 GiacoCorsiglia,他在 giacocorsiglia/wordpress-stubs 上做了所有艰苦的工作,这是我们毫不客气地借鉴的。

* 如果您正在使用 ACF Pro,请参阅 paulthewalton/acf-pro-stubs

安装

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

composer require --dev paulthewalton/acf-stubs

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

Intellisense 的使用方法

从 Wordpress Stubs

如果您的编辑器在解析所有 WordPress 时遇到困难,您可能会发现这些占位符对于启用代码完成和相关功能很有用。例如,有关在 VSCode 的 Intelephense 扩展中使用占位符的说明,请参阅 此处。(然而,根据我的经验,Intelephense 对 WordPress 核心进行了解析。)

版本控制

此包的版本与生成占位符的 ACF 版本相匹配。如果需要修复占位符,后续版本将版本化为 ACF_VERSION.X

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

您应该运行 PHP 7.1 或更高版本以遵循以下步骤,因此从旧版本 PHP 的函数定义中排除了多版本填充。此外,占位符生成器包至少需要 PHP 7.1。

  1. 克隆此存储库并 cd 进入。
  2. composer.json 中将 "wpackagist-plugin/advanced-custom-fields": "X.X.X" 更新为您的所需版本。
  3. 运行 composer update
  4. 运行 ./generate.sh

现在应更新 acf-stubs.php 文件。如果您希望看到新版本的发布,请随时提交 Pull Request。如果进度落后了,请在单独的提交中为每个缺失的版本生成存根,以便我们可以有一个持续的发布历史。