log1x/acf-field-boilerplate

There is no license information available for the latest version (v2.0.1) of this package.

A clean starting point for custom Advanced Custom Fields field types.

v2.0.1 2021-09-25 23:57 UTC

Requires

• php: >=7.2

Requires (Dev)

• squizlabs/php_codesniffer: ^3.5

Unknown License

• wordpress
• wordpress-plugin
• acf
• acf-field

README

This is an ACF Field Type boilerplate to quickly make clean, well structured custom field types.

This is entirely based off of the original acf-field-type-template provided by the creator of ACF.

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:

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

Getting Started

Create a project using Composer:

$ 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.

Contributing

Contributing whether it be through PRs, reporting an issue, or suggesting an idea is encouraged and appreciated.

License

ACF Field Boilerplate is provided under the MIT License.