-
Notifications
You must be signed in to change notification settings - Fork 6
/
readme.txt
71 lines (46 loc) · 4.01 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
=== WP REST API Controller ===
Contributors: yikesinc, eherman24, liljimmi, yikesitskevin, jpowersdev, codeparrots
Tags: rest, api, endpoint, controller, meta, data, meta_data, toggle, endpoints, rest_base, rest_name, REST API, yikes, inc, codeparrots
Requires at least: WordPress 4.7
Tested up to: 6.0
Stable tag: 2.1.2
License: GPLv3 or later
License URI: http://www.gnu.org/licenses/gpl-3.0.txt
Enable a UI to toggle visibility and customize properties in WP REST API requests.
== Description ==
WP REST API Controller allows admins to toggle the visibility of, and customize the endpoints for, all core and *custom* post types and taxonomies within WordPress with an easy-to-use graphical interface. Additionally, you can tweak visibility and customize the meta data attached to the API response.
> **Note:** This plugin requires WordPress Version 4.7 or later to work.
**Features:**
* Enable/Disable REST API endpoints for post types and taxonomies.
* Enable/Disable post type/taxonomy meta data (add or remove meta fields from API requests).
* Rename post type/taxonomy base endpoints.
* Rename post type/taxonomy meta data names in API requests so they are more user friendly.
* Manipulate and control post types/taxonomies and their data created by third party plugins and themes.
* Granular control of API responses without writing a single line of PHP code.
* Filters included to alter and extend default functionality.
* Localized and ready for translations.
== Installation ==
1. Download the plugin .zip file and make note of where on your computer you downloaded it to.
2. In the WordPress admin (yourdomain.com/wp-admin) go to Plugins > Add New or click the "Add New" button on the main plugins screen.
3. On the following screen, click the "Upload Plugin" button.
4. Browse your computer to where you downloaded the plugin .zip file, select it and click the "Install Now" button.
5. After the plugin has successfully installed, click "Activate Plugin" and enjoy!
6. Find the WP REST API Controller Settings screen under the **Tools** menu in the WordPress Admin
== Frequently Asked Questions ==
= 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? =
Yes, you can alter all core public post types and taxonomies using this plugin. You can enable/disable all public post types and taxonomies on your site, and enable/disable/customize their meta data using this plugin.
= 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 all of the post types within WordPress.
= Can I customize the meta data assigned to post types? =
Yes! Users can enable or disable custom meta data assigned to each post type. 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](https://wordpress.org/plugins/advanced-custom-fields/), [CMB2](https://wordpress.org/plugins/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.
<strong>Note:</strong> 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.
== Screenshots ==
1. WP REST API Controller settings page.
== Changelog ==
* Fixed the REST API endpoint when the `rest_base` value is empty when a post type is registered.