Title: REST API Enabler
Author: Mickey Kay
Published: <strong>9 Deireadh Fómhair, 2015</strong>
Last modified: 4 Deireadh an tSamhraidh, 2016

---

Search plugins

This plugin **hasn’t been tested with the latest 3 major releases of WordPress**.
It may no longer be maintained or supported and may have compatibility issues when
used with more recent versions of WordPress.

![](https://s.w.org/plugins/geopattern-icon/rest-api-enabler.svg)

# REST API Enabler

 By [Mickey Kay](https://profiles.wordpress.org/mcguive7/)

[Download](https://downloads.wordpress.org/plugin/rest-api-enabler.1.1.0.zip)

 * [Details](https://ga.wordpress.org/plugins/rest-api-enabler/#description)
 * [Reviews](https://ga.wordpress.org/plugins/rest-api-enabler/#reviews)
 *  [Installation](https://ga.wordpress.org/plugins/rest-api-enabler/#installation)
 * [Development](https://ga.wordpress.org/plugins/rest-api-enabler/#developers)

 [Support](https://wordpress.org/support/plugin/rest-api-enabler/)

## Description

**Like this plugin? Please consider [leaving a 5-star review](https://wordpress.org/support/view/plugin-reviews/rest-api-enabler).**

By default, custom post types and custom fields are not accessible via the WordPress
REST API. REST API Enabler allows you to:

 1. Enable the WP REST API for custom post types and specify WP REST API custom endpoints.
 2. Choose which custom fields to include in WP REST API responses for posts, pages,
    and custom post types.

All enabled custom field data is included in the REST API response, nested under
the `rest_api_enabler` key, like so:

    ```
    [
      {
        "id": 179,
        "date": "2016-07-03T18:06:50",
        "title": {
          "rendered": "Test Job"
        },
        .
        .
        .
        "rest_api_enabler": {
          "custom_meta_1": "Value 1",
          "custom_meta_2": "Value 2",
          "custom_meta_3": [
            "Array value 1",
            "Array value 2"
          ]
        }
      }
    ]
    ```

Note: prior to verion 1.1.0, all meta keys were included as top-level keys in the
API response. Additionally, all values were returned as arrays, regardless of whether
the original value was actually an array. This functionality is now deprecated as
it risks key-name collisions. Please reference the `rest_api_enabler` top-level 
key instead.

#### Úsáid

 1. Activate the plugin, then go to **Settings → REST API Enabler** in the admin.
 2. Click the **Post Types** tab to enable/disable post types and customize their endpoints.
 3. Click the **Post Meta** tab to enable/disable post meta (custom fields).

**NOTE:** by default, the plugin does not display settings for protected post meta(
post meta that begins with an underscore and is intended for internal use only).
If you wish to include protected post meta in the plugin settings, you can use the`
rae_include_protected_meta` filter to do so. The following code can be placed in
your theme’s `functions.php` file, or in a custom plugin (on `init` priority 10 
or earlier):

    ```
    add_filter( 'rae_include_protected_meta', '__return_true' );
    ```

## Screenshots

 * [[
 * Enabling post types and customizing their endpoints.

## Installation

#### Manual Installation

 1. Upload the entire `/rest-api-enabler` directory to the `/wp-content/plugins/` directory.
 2. Activate REST API Enabler through the ‘Plugins’ menu in WordPress.

## Reviews

![](https://secure.gravatar.com/avatar/b56f301f4060d564494fc7d704536bc85ee810378fd71c03108265c7c298455d?
s=60&d=retro&r=g)

### 󠀁[Great !!](https://wordpress.org/support/topic/great-4725/)󠁿

 [imaginocharme](https://profiles.wordpress.org/imaginocharme/) 3 Meán Fómhair, 
2016

Great job, save me a lot of time .

![](https://secure.gravatar.com/avatar/2eff02d9622e2f8af5a5f80cefa2ce50735dff2728eb8443308ca6995b6f133d?
s=60&d=retro&r=g)

### 󠀁[Nice Job….exactly what i needed](https://wordpress.org/support/topic/nice-jobexactly-what-i-needed/)󠁿

 [TomLeonard](https://profiles.wordpress.org/tomleonard/) 3 Meán Fómhair, 2016

Nice Job….exactly what i needed . Very easy settings and Meta data page made it 
a breeze to add . Thanks Mickey!!

![](https://secure.gravatar.com/avatar/cca9f1a3fb857e74c0a2724a3b186b2d8513579974140561095f1881eab3b584?
s=60&d=retro&r=g)

### 󠀁[straight to the point](https://wordpress.org/support/topic/straight-to-the-point-6/)󠁿

 [muhaye](https://profiles.wordpress.org/muhaye/) 3 Meán Fómhair, 2016

Thank you, this is a very simple yet usefull plugin. saved me the time to create
one my self

 [ Read all 3 reviews ](https://wordpress.org/support/plugin/rest-api-enabler/reviews/)

## Contributors & Developers

“REST API Enabler” is open source software. The following people have contributed
to this plugin.

Contributors

 *   [ Mickey Kay ](https://profiles.wordpress.org/mcguive7/)

“REST API Enabler” has been translated into 1 locale. Thank you to [the translators](https://translate.wordpress.org/projects/wp-plugins/rest-api-enabler/contributors)
for their contributions.

[Translate “REST API Enabler” into your language.](https://translate.wordpress.org/projects/wp-plugins/rest-api-enabler)

### Interested in development?

[Browse the code](https://plugins.trac.wordpress.org/browser/rest-api-enabler/),
check out the [SVN repository](https://plugins.svn.wordpress.org/rest-api-enabler/),
or subscribe to the [development log](https://plugins.trac.wordpress.org/log/rest-api-enabler/)
by [RSS](https://plugins.trac.wordpress.org/log/rest-api-enabler/?limit=100&mode=stop_on_copy&format=rss).

## Changelog

#### 1.1.0

 * Add mapping of meta keys to be nested under the new top level rest_api_enabler
   response key. Note: top-level key support is still maintained, though now considered
   deprecated.
 * Add functionality to support singular and array values, to prevent issue in which
   ALL values were previously returned as arrays.

#### 1.0.2

 * Fix issue in which media uploads via the REST API don’t work.

#### 1.0.1

 * Fix typo preventing post meta enabling.
 * Fix post meta alphabetical sorting.

#### 1.0.0

 * First release

## Meta

 *  Version **1.1.0**
 *  Last updated **10 mbliana ago**
 *  Active installations **200+**
 *  WordPress version ** 3.5 or higher **
 *  Tested up to **4.4.34**
 *  Languages
 * [Dutch](https://nl.wordpress.org/plugins/rest-api-enabler/) and [English (US)](https://wordpress.org/plugins/rest-api-enabler/).
 *  [Translate into your language](https://translate.wordpress.org/projects/wp-plugins/rest-api-enabler)
 * Tags
 * [api](https://ga.wordpress.org/plugins/tags/api/)[custom](https://ga.wordpress.org/plugins/tags/custom/)
   [post](https://ga.wordpress.org/plugins/tags/post/)[rest](https://ga.wordpress.org/plugins/tags/rest/)
   [type](https://ga.wordpress.org/plugins/tags/type/)
 *  [Advanced View](https://ga.wordpress.org/plugins/rest-api-enabler/advanced/)

## Ratings

 5 out of 5 stars.

 *  [  3 5-star reviews     ](https://wordpress.org/support/plugin/rest-api-enabler/reviews/?filter=5)
 *  [  0 4-star reviews     ](https://wordpress.org/support/plugin/rest-api-enabler/reviews/?filter=4)
 *  [  0 3-star reviews     ](https://wordpress.org/support/plugin/rest-api-enabler/reviews/?filter=3)
 *  [  0 2-star reviews     ](https://wordpress.org/support/plugin/rest-api-enabler/reviews/?filter=2)
 *  [  0 1-star reviews     ](https://wordpress.org/support/plugin/rest-api-enabler/reviews/?filter=1)

[Your review](https://wordpress.org/support/plugin/rest-api-enabler/reviews/#new-post)

[See all reviews](https://wordpress.org/support/plugin/rest-api-enabler/reviews/)

## Contributors

 *   [ Mickey Kay ](https://profiles.wordpress.org/mcguive7/)

## Support

Got something to say? Need help?

 [View support forum](https://wordpress.org/support/plugin/rest-api-enabler/)

## Donate

Would you like to support the advancement of this plugin?

 [ Donate to this plugin ](http://wordpress.org/plugins/rest-api-enabler)