FAQ

Can I toggle the visibility of endpoints?

Yes! You can quickly and easily toggle the endpoints, so they are either accessible or inaccessible to API requests. Using our interface you can enable the post types you need, while disabling the ones you don’t.

Can I alter the default REST endpoints using this plugin?

You can not change the default post (posts) and page (pages) post type endpoints. For posts, you can only control custom post type endpoints. For taxonomies, you can control the default categories and tags endpoints and data.

Can I alter REST endpoints for post types from other plugins or my theme?

Yes! Our plugin simply filters the rest_base parameter for the custom post type, so you can setup or alter REST endpoints for every custom post type on your site!

Are all post types customizable using this plugin?

Our plugin allows you to customize most of the post types within WordPress. However, we have excluded the posts, pages, nav_menu_items and revisions post types by default. As WordPress Core continues to develop REST API functionality, these post types may change.

Can we customize the meta data assigned to post types?

Yes! Users can enable or disable custom meta data assigned to each post. You can also change the name of the property for each meta data in the API request. If you assign custom meta fields to your posts using Advanced Custom Fields, CMB2 or add_meta_box() you can adjust the visibility, and customize the name, of the property in API requests.

Is this plugin compatible with the Core WordPress 4.7 REST API?

Yes! Version 1.3 of this plugin is compatible with WordPress 4.7.

How do I retrieve repeating postmeta fields?

A repeating postmeta field is one where there are multiple database entries for a single meta key. The default behavior of this plugin did not deal with these fields correctly (i.e. it only returned the first value). As of v1.4.1, a new filter has been added – wp_rest_api_controller_retrieve_meta_single – that allows you to retrieve all of the repeating post meta fields. The reason this was not set as the default behavior is that it changes the data structure of non-repeating fields (i.e. all postmeta values will be returned as arrays). This filter has three parameters: $single – the boolean value for returning postmeta as arrays or as single items, $renamed_meta_key_name – the renamed name of the meta_key we’re retrieving and $original_meta_key_name – the original meta key name. These parameters allow you to specifically determine which fields you want returned as arrays. As always, if you have any questions please reach out to us on GitHub or through the WordPress Support forum.

Note: All properties in the API request are populated using get_post_meta() or get_term_meta(). If you need to filter a meta value, you can use the wp_rest_api_controller_api_property_value filter provided by this plugin.