Download the PHP package jofrysutanto/windsor without Composer
On this page you can find all versions of the php package jofrysutanto/windsor. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jofrysutanto/windsor
More information about jofrysutanto/windsor
Files in jofrysutanto/windsor
Package windsor
Short Description YAML-ised Configuration for ACF
License Apache-2.0
Homepage https://github.com/jofrysutanto/windsor
Informations about the package windsor
ACF Windsor
This package extends Advanced Custom Fields plugin for WordPress and enable developers to write their ACF fields blazingly fast in configuration file.
Features
- Permanently lock your custom fields in your version-controlled code, preventing accidental edits that quickly leads to out-of-sync configurations.
- Create your fields much faster, especially when complimented with the IDE integration.
- Composition is at the heart of it. Write your own rules to further supercharge your development productivity.
Getting Started
-
The easiest way to install Windsor is to use composer:
- 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: -
Register Windsor on ACF initialization. You may also do this in
functions.php
file: -
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: -
Test your installation:
-
Create your first custom field YAML, for example create a file
your-theme/acf-fields/page-default.acf.yaml
: -
Register this new ACF file in your index:
- You have successfully registered a new field group which will be made available when creating a new default page.
-
- Check out our full documentation below. Now go and create beautiful ACF fields!
Migrating Existing Fields
If you have existing field groups created through ACF interface, you can easily export them out to YAML by enabling the exporter through ui
configuration when registering 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.
Learn More
Check out full documentations at https://windsor-docs.netlify.app/
IDE Integration
Only VSCode integration is available at the moment. To enable autocompletion and useful snippets, follow the installation steps below:
- If not already installed, download and enable YAML language server extension.
- Update your VSCode settings (i.e.
settings.json
):
Credits
This package is written to be used with Advanced Custom Fields plugin by Elliot Condon, who deserves most of the credits for delivering and maintaining such an incredible plugin for WordPress developers.
If you have not already started using Advanced Custom Fields, be sure to check it out; it will definitely be worth your while.