Exposes Advanced Custom Fields Endpoints in the WordPress REST API
Clone or download
Latest commit 3382b35 Apr 3, 2018
Permalink
Failed to load latest commit information.
languages 3.0.0-beta Feb 28, 2017
legacy/v2 3.0.0-beta Feb 28, 2017
shared 3.0.0-beta Feb 28, 2017
v3 3.1.0 Oct 18, 2017
class-acf-to-rest-api.php 3.1.0 Oct 18, 2017
composer.json 3.1.0 Oct 18, 2017
readme.md readme Apr 3, 2018
readme.txt readme Apr 3, 2018

readme.md

ACF to REST API

Exposes Advanced Custom Fields Endpoints in the WordPress REST API

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

Installation

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

Endpoints

Endpoint READABLE EDITABLE
/wp-json/acf/v3/posts new yes no
/wp-json/acf/v3/posts/{id} yes yes
/wp-json/acf/v3/posts/{id}/{field-name} yes yes
/wp-json/acf/v3/pages new yes no
/wp-json/acf/v3/pages/{id} yes yes
/wp-json/acf/v3/pages/{id}/{field-name} yes yes
/wp-json/acf/v3/users new yes no
/wp-json/acf/v3/users/{id} yes yes
/wp-json/acf/v3/users/{id}/{field-name} yes yes
/wp-json/acf/v3/{taxonomy} new yes no
/wp-json/acf/v3/{taxonomy}/{id} new yes yes
/wp-json/acf/v3/{taxonomy}/{id}/{field-name} new yes yes
/wp-json/acf/v3/comments new yes no
/wp-json/acf/v3/comments/{id} yes yes
/wp-json/acf/v3/comments/{id}/{field-name} yes yes
/wp-json/acf/v3/media new yes no
/wp-json/acf/v3/media/{id} yes yes
/wp-json/acf/v3/media/{id}/{field-name} yes yes
/wp-json/acf/v3/{post-type} new yes no
/wp-json/acf/v3/{post-type}/{id} new yes yes
/wp-json/acf/v3/{post-type}/{id}/{field-name} new yes yes
/wp-json/acf/v3/options/{id} new yes yes
/wp-json/acf/v3/options/{id}/{field-name} new yes yes

Filters

Filter Argument(s)
acf/rest_api/id mixed ( string, integer, boolean ) $id
string $type new
string $controller new
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 new boolean $show
acf/rest_api/field_settings/edit_in_rest new boolean $edit

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

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.

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

Choose request API version

The other alternative is to define the constant ACF_TO_REST_API_REQUEST_VERSION in your wp-config.php

define( 'ACF_TO_REST_API_REQUEST_VERSION', 2 );

Field Settings

In this version is possible to configure the field options via admin.

The options are enabled using the filters below, by default theses options are disabled.

// 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' );

After you activate the filters, all your fields should show these options: Choose request API version

Editing the fields

The fields should be sent into the key fields.

Field Name

Action: http://localhost/wp-json/acf/v3/posts/1

<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

<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.

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

<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.

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

To-do list new

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

Get ACF Fields Recursivelynew

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

More details:

Cache

Enable caching for WordPress REST API and increase speed of your application.

https://github.com/airesvsg/wp-rest-api-cache