README

本软件包扩展了 Advanced Custom Fields 插件，并允许开发者在配置文件中快速编写 ACF 字段。

功能

• 永久锁定你的自定义字段在你的版本控制代码中，防止意外编辑导致配置不同步。
• 创建字段更快，尤其是当与 IDE 集成配合使用时。
• 组合是其核心。编写你自己的规则来进一步提高你的开发效率。

入门指南

• 安装 Windsor 最简单的方法是使用 composer

composer require jofrysutanto/windsor

• 如果你正在使用 VSCode，请确保将 Schema 文件添加到你的配置中。
• 确保你已经包含了 composer 自动加载文件。如果你不确定，请将以下行添加到你的 functions.php 文件中

require_once __DIR__ . '/vendor/autoload.php';

• 在 ACF 初始化时注册 Windsor。你也可以在 functions.php 文件中这样做

function register_acf_windsor()
{
    \Windsor\Capsule\Manager::make()->register();
}
add_action('acf/init', 'register_acf_windsor');

• 在 [your-active-theme]/acf-fields/index.yaml 创建 YAML 条目文件，其中 [your-active-theme] 指的是你目前活动的 WordPress 主题目录。你的条目文件至少应包含

fields: []
pages: []
blocks: []

• 测试你的安装
  • 创建你的第一个自定义字段 YAML，例如创建一个文件 your-theme/acf-fields/page-default.acf.yaml

  title: 'Page Default'
  key: 'page_default'
  position: 'acf_after_title'
  hide_on_screen: []
  location:
    -
      -
        param: 'page_template'
        operator: '=='
        value: 'default'
  fields:
    heading:
      type: text
      label: Heading

  • 在你的索引中注册这个新的 ACF 文件

  fields: []
  pages:
    - page-default.acf.yaml
  blocks: []

  • 你已成功注册了一个新字段组，当创建新默认页面时将可用。
• 查看以下完整文档。现在去创建漂亮的 ACF 字段吧！

迁移现有字段

如果你通过 ACF 接口创建了现有的字段组，你可以通过在注册 Windsor 时启用通过 ui 配置的导出器来轻松地将它们导出为 YAML

function register_acf_windsor()
{
    \Windsor\Capsule\Manager::make([
        'ui' => true
      ])
      ->register();
}
add_action('acf/init', 'register_acf_windsor');

启用后，你可以在 WordPress 后端通过点击侧边栏中的自定义字段 > 导出到 YAML 链接来访问导出器。

有关此工具的更多信息，请参阅 配置部分。

了解更多

在 https://windsor-docs.netlify.app/ 查看完整文档

IDE 集成

目前仅提供 VSCode 集成。要启用自动完成和有用的代码片段，请按照以下安装步骤操作

• 如果尚未安装，请下载并启用 YAML 语言服务器 扩展。
• 更新你的 VSCode 设置（即 settings.json）

"yaml.schemas": {
    "https://windsor-docs.netlify.app/schema.json": "*.acf.yaml"
}

致谢

本软件包是为与 Advanced Custom Fields 插件一起使用的，该插件由 Elliot Condon 编写，他应获得大部分荣誉，因为他为 WordPress 开发者提供了这样一个出色的插件。

如果你还没有开始使用 Advanced Custom Fields，请确保查看它；它绝对值得你投入时间。