Getting Started

• Install ACF Windsor via composer in your theme:

composer require jofrysutanto/windsor

• If you are using VSCode, be sure to add the Schema file to your configuration.
• Ensure you have included composer auto-loader file. If you're not sure, add the following line into your functions.php file:

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

• Register Windsor on ACF initialization. You may also do this in functions.php file:

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

• Create YAML entry file at [your-active-theme]/acf-fields/index.yaml, where [your-active-theme] refers to your currently active WordPress theme directory. At minimum, your entry file should contain:

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

• Test your installation:
  • Create your first custom field YAML, for example create a file your-theme/acf-fields/page-default.acf.yaml:

  Convention for files extension

  Other than the entry file index.yaml, all other files must have .acf.yaml extension.

  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
  

  • Register this new ACF file in your index:

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

  • You have successfully registered a new field group which will be made available when creating a new default page.
  • For more in-depth guide, check out the guides section

Have an existing fields in ACF?

You can access the exporter tool by enabling ui configuration when registering Windsor:

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

Once enabled, you access the exporter within WordPress backend by clicking on Custom Fields > Export to YAML link in sidebar.

More information about this tool can be found in configurations section.