CODEWITHSUNDEEP
phpwordpressadvanced-custom-fieldswordpress-rest-api
Mel Macaluso
Mel Macaluso

Reputation: 3760

How to expose all the ACF fields to Wordpress REST API in both pages and custom postypes

I want to expose all the ACF fields that belong to a page or custom post type to the WordPress REST API in order to do some API calls through javascript.

The final expected result would be all the ACF fields inside an ACF object that you can easily access.

Upvotes: 22

Views: 37173

Answers (4)

calmar
calmar

Reputation: 1959

Another simple solution that is working perfect for me now. You can add the following function on functions.php or fields.php Using ACF getFields before sending a rest request. You can add this to any special page rest_prepare_page or rest_prepare_post.

The ACF data will be in the json response with key acf

// add this to functions.php
//register acf fields to Wordpress API
//https://support.advancedcustomfields.com/forums/topic/json-rest-api-and-acf/

function acf_to_rest_api($response, $post, $request) {
    if (function_exists('get_fields') && isset($post->ID)) {
        $response->data['acf'] = get_fields($post->ID);
    }
    return $response;
}
add_filter('rest_prepare_post', 'acf_to_rest_api', 10, 3);

Upvotes: 37

Sagar Bahadur Tamang
Sagar Bahadur Tamang

Reputation: 2709

You can use the following plugin to expose the ACF fields in REST.

https://wordpress.org/plugins/acf-to-rest-api/

If your ACF fields have a relationship and want to include those relationships in rest as well, you can use the following plugin.

https://github.com/airesvsg/acf-to-rest-api-recursive

Update: ACF has own settings to add ACF fields to REST Response. So, you don't need to use it.

Upvotes: 1

Ron
Ron

Reputation: 201

ACF has the ability to have fields added to the REST API via each field as of version 5.11. You can review the update here: https://www.advancedcustomfields.com/resources/rest-api/

The gist is that each field has a setting for "Show in REST API". By default it is set to "No", but if you switch this to "Yes" it will be added to the REST data for each post/custom post type.

Upvotes: 7

Mel Macaluso
Mel Macaluso

Reputation: 3760

Through the following code, you will be able to expose page and your custom postypes ACF fields in the wordpress REST API and access them inside the ACF object.

You can obviously customise the postypes to exclude or to include in the arrays: $postypes_to_exclude and $extra_postypes_to_include.

function create_ACF_meta_in_REST() {
    $postypes_to_exclude = ['acf-field-group','acf-field'];
    $extra_postypes_to_include = ["page"];
    $post_types = array_diff(get_post_types(["_builtin" => false], 'names'),$postypes_to_exclude);

    array_push($post_types, $extra_postypes_to_include);

    foreach ($post_types as $post_type) {
        register_rest_field( $post_type, 'ACF', [
            'get_callback'    => 'expose_ACF_fields',
            'schema'          => null,
       ]
     );
    }

}

function expose_ACF_fields( $object ) {
    $ID = $object['id'];
    return get_fields($ID);
}

add_action( 'rest_api_init', 'create_ACF_meta_in_REST' );

Here's the gist for reference: https://gist.github.com/MelMacaluso/6c4cb3db5ac87894f66a456ab8615f10

Upvotes: 20

Related Questions