Welcome to the Advanced Custom Fields field type template repository. Here you will find a starter-kit for creating a new ACF field type. This start-kit will work as a normal WP plugin.
For more information about creating a new field type, please read the following article: http://www.advancedcustomfields.com/resources/tutorials/creating-a-new-field-type/
/css
: folder for .css files./images
: folder for image files/js
: folder for .js files/lang
: folder for .pot, .po and .mo filesacf-FIELD_NAME.php
: Main plugin file that includes the correct field file based on the ACF versionFIELD_NAME-v5.php
: Field class compatible with ACF version 5FIELD_NAME-v4.php
: Field class compatible with ACF version 4readme.txt
: WordPress readme file to be used by the wordpress repository
This template uses PLACEHOLDERS
such as FIELD_NAME
throughout the file names and code. Use the following list of placeholders to do a 'find and replace':
FIELD_NAME
: Single word, no spaces. Underscores allowed. eg. donate_buttonFIELD_LABEL
: Multiple words, can include spaces, visible when selecting a field type. eg. Donate ButtonPLUGIN_URL
: Url to the github or WordPress repositoryPLUGIN_TAGS
: Comma seperated list of relevant tagsDESCRIPTION
: Brief description of the field type, no longer than 2 linesEXTENDED_DESCRIPTION
: Extended description of the field typeAUTHOR_NAME
: Name of field type authorAUTHOR_URL
: URL to author's website
Edit the FIELD_NAME-v5.php
and FIELD_NAME-v4.php
files (now renamed using your field name) and include your custom code in the appropriate functions.
Please note that v4 and v5 field classes have slightly different functions. For more information, please read:
Edit this README.md
file with the appropriate information and delete all content above and including the following line.
DESCRIPTION
EXTENDED_DESCRIPTION
This ACF field type is compatible with:
- ACF 5
- ACF 4
- Copy the
acf-FIELD_NAME
folder into yourwp-content/plugins
folder - Activate the FIELD_LABEL plugin via the plugins admin page
- Create a new field via ACF and select the FIELD_LABEL type
- Please refer to the description for more info regarding the field type settings
Please see readme.txt
for changelog