v1.3 - Notification

WordPress.org Extensions Support

Search…

v1.3

Legacy version

​
You are reading the documentation for version 1.3. Please update the plugin and refer to the latest documentation.
Regular meta
The Custom Fields extension supports meta of three object types:
Posts
Users
Comments
Here are the examples with equivalents in get_****_meta()
1
{postmeta {post_ID} metakey}
2
// equivalent of:
3
// get_post_meta( $post_id, $metakey, true );
Copied!
1
{usermeta {user_ID} metakey}
2
// equivalent of:
3
// get_user_meta( $user_id, $metakey, true );
Copied!
1
{commentmeta {comment_ID} metakey}
2
// equivalent of:
3
// get_comment_meta( $comment_id, $metakey, true );
Copied!
Note that {post_ID} or {user_ID} or {comment_ID} part is the object ID which can be static (like just 365783) or can be a merge tag. If you are using merge tags for this part, like in the examples, please make sure you can see this merge tag in the sidebar. So if you choose the Book updated trigger, the {post_ID} will become {book_ID}.
Advanced Custom Fields meta
Any ACF field value can be get with the regular meta merge tags, but sometimes you'd want to let ACF format the data for you.
Very similar to regular meta you can use it like this:
1
{acf {post_ID} my_field_slug}
2
{acf comment_{comment_ID} fieldname}
3
{acf user_{user_ID} fieldname}
4
{acf term_{term_ID} fieldname}
Copied!
Which is an equivalent of:
1
get_field( $fieldname, $item_id );
Copied!
You can access the first-level array key as well
Giving an example, you can have a field of type User and return format of User array. Your meta will look like this:
1
Array
2
(
3
    [ID] => 1
4
    [user_firstname] => Panda
5
    [user_lastname] => Bear
6
    [nickname] => admin
7
    [user_nicename] => admin
8
    [display_name] => Panda Bear
9
    [user_email] => [email protected]
10
    [user_url] => 
11
    [user_registered] => 2019-03-14 10:46:17
12
    [user_description] => 
13
    [user_avatar] => <img alt='' src='http://2.gravatar.com/avatar/21c9a0124feee215cb7c5759f7e6670b?s=96&#038;d=mm&#038;r=g' srcset='http://2.gravatar.com/avatar/21c9a0124feee215cb7c5759f7e6670b?s=192&#038;d=mm&#038;r=g 2x' class='avatar avatar-96 photo' height='96' width='96' />
14
)
Copied!
To access the user_email key, you just need to do it like this:
1
{acf {post_ID} user_field:user_email}
Copied!
Access array keys
You can also get array values from meta and access their first-level keys.
Let's consider an example, where you have this array in your meta:
1
Array
2
(
3
    [date] => 2019-03-14 10:46:17
4
    [accepted] => 1
5
    [email] => '[email protected]'
6
)
Copied!
To access the email key you just need to pass the array key after the colon:
1
{postmeta {post_ID} metakey:email}
Copied!
This will work with any type of meta.
Giving the ACF example, you can have a field of type User and return format of User array. Your meta will look like this:
1
Array
2
(
3
    [ID] => 1
4
    [user_firstname] => Panda
5
    [user_lastname] => Bear
6
    [nickname] => admin
7
    [user_nicename] => admin
8
    [display_name] => Panda Bear
9
    [user_email] => [email protected]
10
    [user_url] => 
11
    [user_registered] => 2019-03-14 10:46:17
12
    [user_description] => 
13
    [user_avatar] => <img alt='' src='http://2.gravatar.com/avatar/21c9a0124feee215cb7c5759f7e6670b?s=96&#038;d=mm&#038;r=g' srcset='http://2.gravatar.com/avatar/21c9a0124feee215cb7c5759f7e6670b?s=192&#038;d=mm&#038;r=g 2x' class='avatar avatar-96 photo' height='96' width='96' />
14
)
Copied!
To access the user_email key, you just need to do it like this:
1
{acf {post_ID} user_field:user_email}
Copied!
Multidimensional array
But what in case you have a multidimensional array like this?
1
Array
2
(
3
    [user] => Array
4
    (
5
        [user_firstname] => Panda
6
        [user_lastname] => Bear
7
        [user_email] => [email protected]
8
    )
9
)
Copied!
Easy! Just pass the nested keys after another colon:
1
{... user_field:user:user_email}
Copied!
Pipelines
Sometimes the value in meta is not exactly in a form you'd like. The most common scenario is having a post or user ID saved in the meta while you want to display a post_title or display_name.
This is where pipelines come to the rescue. Let's assume you have a Taxonomy ACF field added to your post, where you can select multiple terms. The raw meta would look like this:
1
Array
2
(
3
    [0] => 14
4
    [1] => 1
5
    [2] => 46
6
)
Copied!
Which are just the term IDs.
To get term names out of these, you can use pipeline like so:
1
{acf {post_ID} taxonomy_field|term:name}
Copied!
The pipeline comes after a | character and we support three pipes:
post
user
term
And do you notice the |term:name array key notation here? That's right, the |term part will get the whole term data and the :name will access the term array key name.
Pipelines are supported by both ACF and regular meta Merge Tags. You can use multidimensional array access as well :with:this:notation 
Accessing ACF Repeater
Since version 1.2.4 you are able to access single level repeater fields, like this:
Repeater field configuration
Which gives results like:
1
Array
2
(
3
    [0] => Array
4
    (
5
        [name] => John Doe
6
    )
7
    [1] => Array
8
    (
9
        [name] => Jane Doe
10
    )
11
)
Copied!
You simply use the array pipe:
1
{acf {post_ID} repeater_field_key|array:name}
Copied!

Extensions - Previous

Next - Extensions

Scheduled Triggers

Last modified 11d ago

Copy link

Contents

Advanced Custom Fields meta

Access array keys

Accessing ACF Repeater