Download the PHP package airesvsg/acf-to-rest-api without Composer
On this page you can find all versions of the php package airesvsg/acf-to-rest-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download airesvsg/acf-to-rest-api
More information about airesvsg/acf-to-rest-api
Files in airesvsg/acf-to-rest-api
Package acf-to-rest-api
Short Description Exposes Advanced Custom Fields Endpoints in the WordPress REST API
License GPL-2.0-only
Homepage https://github.com/airesvsg/acf-to-rest-api
Informations about the package acf-to-rest-api
ACF to REST API
Exposes Advanced Custom Fields Endpoints in the WordPress REST API
https://wordpress.org/plugins/acf-to-rest-api/
- 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 yourwp-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
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.
- 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
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.
Editing the fields
The fields should be sent into the key fields
.
Action: http://localhost/wp-json/acf/v3/posts/1
Action: http://localhost/wp-json/wp/v2/posts/1
Use the filter acf/rest_api/key
to change the key fields
.
Now, the fields should be sent into the key acf_fields
Examples
Sample theme to edit the ACF Fields.
https://github.com/airesvsg/acf-to-rest-api-example
To-do list π
https://github.com/airesvsg/to-do-list-acf-to-rest-api
Get ACF Fields Recursivelyπ
https://github.com/airesvsg/acf-to-rest-api-recursive
More details:
-
Issues
- Pull Request
Cache
Enable caching for WordPress REST API and increase speed of your application.