ACF to REST API

Exposes Advanced Custom Fields Endpoints in the WordPress REST API, _(*1)

https://wordpress.org/plugins/acf-to-rest-api/, _(*2)

Installation
Endpoints
Filters
Deprecated Filters 🆕
Request API Version 🆕
Field Settings 🆕
Editing the Fields
Examples
Get ACF Fields Recursively 🆕
Cache

Installation

Copy the acf-to-rest-api folder into your wp-content/plugins folder
Activate the ACF to REST API plugin via the plugin admin page

Endpoints

Endpoint	READABLE	EDITABLE
/wp-json/acf/v3/posts 🆕	✅	❌
/wp-json/acf/v3/posts/{id}	✅	✅
/wp-json/acf/v3/posts/{id}/{field-name}	✅	✅
/wp-json/acf/v3/pages 🆕	✅	❌
/wp-json/acf/v3/pages/{id}	✅	✅
/wp-json/acf/v3/pages/{id}/{field-name}	✅	✅
/wp-json/acf/v3/users 🆕	✅	❌
/wp-json/acf/v3/users/{id}	✅	✅
/wp-json/acf/v3/users/{id}/{field-name}	✅	✅
/wp-json/acf/v3/{taxonomy} 🆕	✅	❌
/wp-json/acf/v3/{taxonomy}/{id} 🆕	✅	✅
/wp-json/acf/v3/{taxonomy}/{id}/{field-name} 🆕	✅	✅
/wp-json/acf/v3/comments 🆕	✅	❌
/wp-json/acf/v3/comments/{id}	✅	✅
/wp-json/acf/v3/comments/{id}/{field-name}	✅	✅
/wp-json/acf/v3/media 🆕	✅	❌
/wp-json/acf/v3/media/{id}	✅	✅
/wp-json/acf/v3/media/{id}/{field-name}	✅	✅
/wp-json/acf/v3/{post-type} 🆕	✅	❌
/wp-json/acf/v3/{post-type}/{id} 🆕	✅	✅
/wp-json/acf/v3/{post-type}/{id}/{field-name} 🆕	✅	✅
/wp-json/acf/v3/options/{id} 🆕	✅	✅
/wp-json/acf/v3/options/{id}/{field-name} 🆕	✅	✅

Filters

Filter	Argument(s)
acf/rest_api/id	mixed ( string, integer, boolean ) $id string $type 🆕 string $controller 🆕
acf/rest_api/key	string $key WP_REST_Request $request string $type
acf/rest_api/item_permissions/get	boolean $permission WP_REST_Request $request string $type
acf/rest_api/item_permissions/update	boolean $permission WP_REST_Request $request string $type
acf/rest_api/{type}/prepare_item	mixed ( array, boolean ) $item WP_REST_Request $request
acf/rest_api/{type}/get_fields	mixed ( array, WP_REST_Request ) $data mixed ( WP_REST_Request, NULL ) $request
acf/rest_api/field_settings/show_in_rest 🆕	boolean $show
acf/rest_api/field_settings/edit_in_rest 🆕	boolean $edit

Basic example of how to use the filters, in this case I will set a new permission to get the fields, _(*3)

add_filter( 'acf/rest_api/item_permissions/get', function( $permission ) {
  return current_user_can( 'edit_posts' );
} );

Deprecated filters

Filter	Argument(s)
acf/rest_api/type	string $type
acf/rest_api/types	array $types
acf/rest_api/default_rest_base	boolean $default string $type

Request API version

See below how to select the Request API Version., _(*4)

Open the plugins page;
Click the settings link under the pluing name ( ACF to REST API );
Select your version in the ACF to REST API session;
Click in the button Save changes.

The other alternative is to define the constant ACF_TO_REST_API_REQUEST_VERSION in your wp-config.php, _(*5)

define( 'ACF_TO_REST_API_REQUEST_VERSION', 2 );

Field Settings

In this version is possible to configure the field options via admin., _(*6)

The options are enabled using the filters below, by default theses options are disabled., _(*7)

// Enable the option show in rest
add_filter( 'acf/rest_api/field_settings/show_in_rest', '__return_true' );

// Enable the option edit in rest
add_filter( 'acf/rest_api/field_settings/edit_in_rest', '__return_true' );

Editing the fields

The fields should be sent into the key fields., _(*8)

Action: http://localhost/wp-json/acf/v3/posts/1, _(*9)

<form action="http://localhost/wp-json/acf/v3/posts/1" method="POST">
  <?php 
    // https://developer.wordpress.org/rest-api/using-the-rest-api/authentication/
    wp_nonce_field( 'wp_rest' ); 
  ?>
  <label>Site: <input type="text" name="fields[site]"></label>
  <button type="submit">Save</button>
</form>

Action: http://localhost/wp-json/wp/v2/posts/1, _(*10)

<form action="http://localhost/wp-json/wp/v2/posts/1" method="POST">
  <?php 
    // https://developer.wordpress.org/rest-api/using-the-rest-api/authentication/
    wp_nonce_field( 'wp_rest' ); 
  ?>
  <label>Title: <input type="text" name="title"></label>
  <h3>ACF</h3>
  <label>Site: <input type="text" name="fields[site]"></label>
  <button type="submit">Save</button>
</form>

Use the filter acf/rest_api/key to change the key fields., _(*11)

add_filter( 'acf/rest_api/key', function( $key, $request, $type ) {
  return 'acf_fields';
}, 10, 3 );

Now, the fields should be sent into the key acf_fields, _(*12)

<form action="http://localhost/wp-json/acf/v3/posts/1" method="POST">
  <?php 
    // https://developer.wordpress.org/rest-api/using-the-rest-api/authentication/
    wp_nonce_field( 'wp_rest' ); 
  ?>
  <label>Site: <input type="text" name="acf_fields[site]"></label>
  <button type="submit">Save</button>
</form>

Examples

Sample theme to edit the ACF Fields., _(*13)

https://github.com/airesvsg/acf-to-rest-api-example, _(*14)

To-do list 🆕, _(*15)

https://github.com/airesvsg/to-do-list-acf-to-rest-api, _(*16)

Get ACF Fields Recursively🆕

https://github.com/airesvsg/acf-to-rest-api-recursive, _(*17)

More details:, _(*18)

Issues, _(*19)
- https://github.com/airesvsg/acf-to-rest-api/issues/109
- https://github.com/airesvsg/acf-to-rest-api/issues/223
- https://github.com/airesvsg/acf-to-rest-api/issues/9
Pull Request, _(*20)
- https://github.com/airesvsg/acf-to-rest-api/pull/95