log1x / acf-field-boilerplate
A clean starting point for custom Advanced Custom Fields field types.
Fund package maintenance!
log1x
Installs: 39
Dependents: 0
Suggesters: 0
Security: 0
Stars: 58
Watchers: 4
Forks: 2
Open Issues: 0
Type:wordpress-plugin
Requires
- php: >=7.2
Requires (Dev)
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:
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 directoryyarn 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.