https://github.com/Log1x/acf-field-boilerplate

Modernized PSR-2 boilerplate for creating custom fields for ACF5.
https://github.com/Log1x/acf-field-boilerplate

acf acf-field acf-field-boilerplate advanced-custom-fields boilerplate wordpress wordpress-plugin

Last synced: 3 months ago
JSON representation

Modernized PSR-2 boilerplate for creating custom fields for ACF5.

• Host: GitHub
• URL: https://github.com/Log1x/acf-field-boilerplate
• Owner: Log1x
• License: mit
• Created: 2017-09-02T04:52:22.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2021-09-25T23:58:56.000Z (about 3 years ago)
• Last Synced: 2024-07-31T01:46:33.637Z (3 months ago)
• Topics: acf, acf-field, acf-field-boilerplate, advanced-custom-fields, boilerplate, wordpress, wordpress-plugin
• Language: PHP
• Homepage: https://github.com/Log1x/acf-field-boilerplate
• Size: 490 KB
• Stars: 58
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# ACF Field Boilerplate

![Latest Stable Version](https://img.shields.io/packagist/v/log1x/acf-field-boilerplate?style=flat-square)

![Total Downloads](https://img.shields.io/packagist/dt/log1x/acf-field-boilerplate?style=flat-square)

![Build Status](https://img.shields.io/github/workflow/status/log1x/acf-field-boilerplate/compatibility)

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](https://github.com/elliotcondon/acf-field-type-template) provided by the creator of ACF.

## Features

- [Laravel Mix](https://laravelmix.com) 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](https://www.advancedcustomfields.com/pro/) >= 5.0

- [PHP](http://php.net/manual/en/install.php) >= 7.2

- [Composer](https://getcomposer.org/download/)

- [Yarn](https://yarnpkg.com/en/docs/install)

## Getting Started

Create a project using Composer:

```sh

$ 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](https://github.com/log1x/acf-field-boilerplate/issues).

## 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](LICENSE.md).