paulethewalton/acf-pro-stubs

该软件包已被 废弃 并不再维护。作者建议使用 php-stubs/acf-pro-stubs 软件包。

为高级定制字段 Pro 函数、类和全局变量声明提供占位符,以便于静态分析。

5.8.9.1 2020-04-09 22:22 UTC

This package is auto-updated.

Last update: 2022-12-04 06:31:26 UTC


README

该项目已被废弃。我建议使用 php-stubs/acf-pro-stubs 代替,因为它更新得多,并且得到积极维护。



WordPress 高级定制字段 PRO 占位符

paulthewalton/acf-stubs 类似,但针对 ACF Pro!

No Maintenance Intended

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

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

非常感谢 GiacoCorsiglia,他在 giacocorsiglia/wordpress-stubs 上做了所有艰苦的工作,这是我毫无愧色地抄袭的。

安装

使用 Composer 将此软件包作为开发依赖项要求

composer require --dev paulthewalton/acf-pro-stubs

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

Intellisense 的使用方法

从 WordPress 占位符

如果您的编辑器难以解析所有 WordPress,您可能会发现这些占位符对于启用代码完成和相关功能很有用。例如,这里 是使用 VSCode 的 Intelephense 扩展的说明。(然而,在我的经验中,Intelephense 仍然可以很好地解析 WordPress 核心。)

版本控制

该软件包的版本与生成占位符的 ACF 版本相匹配。如果需要修复占位符,后续版本将按 ACF_VERSION.X 进行版本控制。

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

检索 ACF Pro 的源代码需要您拥有有效的许可证密钥。您应该运行 PHP 7.1 或更高版本才能遵循以下步骤,因此任何针对旧版 PHP 的函数定义都被排除在占位符之外。此外,占位符生成器软件包至少需要 PHP 7.1。

  1. 克隆此存储库并将 cd 放入其中。

  2. 设置环境变量 ACF_PRO_KEY 为您的 ACF PRO 密钥

    或者您可以在.env文件中添加一个条目

    # .env (same directory as composer.json)
    ACF_PRO_KEY=Your-Key-Here
  3. composer.json中更新版本号为您想要的版本

    选择较旧版本

    如果您为ACF Pro的较旧版本生成占位符,只需在依赖数组中指定较低的版本号。

    "advanced-custom-fields/advanced-custom-fields-pro": "X.X.X"

    选择较新版本

    要从ACF Pro的较新版本生成,您需要更改包存储库中的版本。

    {
        "type": "package",
        "package": {
            "name": "advanced-custom-fields/advanced-custom-fields-pro",
            "version": "X.X.X",
            //...
        }
    }
  4. 运行composer update

  5. 运行./generate.sh

现在应该已更新acf-pro-stubs.php文件。如果您想看到较新版本的发布,请随时提交一个Pull Request。如果落后了,请为每个缺失的版本在单独的提交中生成占位符,以便我们有一个持续的发布历史。