log1x/acf-field-boilerplate

A simple ACF field boilerplate with clean syntax.

ACF Field Boilerplate

, _(*1)

This is an ACF Field Type boilerplate to quickly make clean, well structured custom field types., _(*2)

This is entirely based off of the original acf-field-type-template provided by the creator of ACF., _(*3)

Features

• Laravel Mix for handling assets.
• Support for Admin Columns Pro
• PSR-12 code style & linting
• Cleaner DocBlocks
• Cleaner directory structure
• Ready to use alongside other Composer packages
• Attempt at a more DRY approach

Requirements

Make sure all dependencies have been installed before moving on:, _(*4)

• ACF >= 5.0
• PHP >= 7.2
• Composer
• Yarn

Getting Started

Create a project using Composer:, _(*5)

$ composer create-project log1x/acf-field-boilerplate:dev-master my-field

Field development

• Run yarn install from the field directory to install dependencies.
• Replace all instances of Log1x/AcfFieldBoilerplate with your namespace.
• Use src/ExampleField.php to get started.

Build commands

• yarn run build — Compile and optimize the files in your assets directory
• yarn run build:production — Compile assets for production

Bug Reports

If you discover a bug in ACF Field Boilerplate, please open an issue., _(*6)

Contributing

Contributing whether it be through PRs, reporting an issue, or suggesting an idea is encouraged and appreciated., _(*7)

License

ACF Field Boilerplate is provided under the MIT License., _(*8)