geoffdusome / acf-meta-builder-helper

A helper WordPress plugin for the ACF Meta Builder gulp task.

@geoffdusome/acf-meta-builder-helper

A helper WordPress plugin for the ACF Meta Builder gulp task.

Installation

Clone or download the plugin and upload entire folder to your WordPress installation (usually located under ./wp-content/plugins/).

Usage

The helper plugin uses a get_post_meta($post->ID) call to pull all of the meta for the page. It will then use that meta array to pull from. This allows us to have all of our meta for the page with one call to the DB, instead of one for every meta call. Please note that for repeater, group and flexible content field types, you will need to use base ACF functions to get this data ($repeater_data = get_field('repeater_name'); should do all you need).

acfmb($type, $name, $group, $options)

This function is the heart of the helper plugin, as well as the heart of the gulp task! This function not only creates the meta, but also pulls the meta value from the meta call above.

$type - string
[required]
The type of field you want to use (view field types here).

$name - string
[required]
The name of the field.

$group - string
[required]
The name of the group the field belongs to.

$options - string (JSON encoded string)
Unused in the helper plugin but optional for the gulp task.

acfmb_image_url($value, $size)

Get image URL from an attachment ID

$value - string
[required]
The ID of the image

$size - string
The defined image size of the image you want to display.

acfmb_link_markup($value, $classes, $wrapper)

Get the link object and provide markup for the button

$value - string
[required]
JSON encoded array from DB.

$classes - string
Classes for the button in string format.

$wrapper - bool
Whether or not to show the wrapper for the button.

$unserialize - bool
Whether or not to unserialize the data given to the function.

Example

If you have both the ACF Meta Builder gulp task as well as the ACF Meta Builder WordPress plugin below is an example of the typical workflow of building meta.

// Create a tab
$hero_tab = acfmb('tab', 'Hero', 'Page Meta');

// Create an image
$hero_background_id = acfmb('image', 'Hero Background', 'Page Meta');
$hero_background = acfmb_image_url($hero_background_id, 'large');

// Create a text field
$hero_headline = acfmb('text', 'Hero Headline', 'Page Meta');