=== Jailbreak Disable REST API ===
Contributors: typisttech, tangrufus
Donate link: https://typist.tech/donation/
Tags: disable-json-api, admin, JSON, api, rest, rest-api
Requires at least: 4.7
Tested up to: 4.9
Stable tag: 0.1.3
License: GPL-2.0-or-later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

[Deprecated] Allow whitelisted REST routes to pass through [Disable REST API](https://wordpress.org/plugins/disable-json-api/) filters

== Description ==

[Deprecated] Allow whitelisted REST routes to pass through [Disable REST API](https://wordpress.org/plugins/disable-json-api/) filters

> [Disable REST API](https://wordpress.org/plugins/disable-json-api/) now supports whitelisting of individual routes since version 1.4.
> This plugin is no longer maintained.

= Define REST route whitelist =

Define 'JAILBREAK_DRA_WHITELIST' constant in `wp-config.php`

`
define('JAILBREAK_DRA_WHITELIST', [
    '/wp/v2/posts',
    '/wp/v2/posts/1234',
    '/wp/v2/tags',
    '/wp/v2/tags/(?P<id>[\\d]+)',
]);

/* That's all, stop editing! Happy blogging. */
`

= Filters =

* `jailbreak_dra_is_whitelisted`

Example:
`
add_filter( 'jailbreak_dra_is_whitelisted', 'example_callback', 10, 3);

function example_callback(bool $isWhitelisted, string $currentRESTRoute, array $whitelist): bool {
    // Perform your checks and return a boolean
    return $isWhitelisted;
}
`

* `jailbreak_dra_whitelist`

Example:
`
add_filter( 'jailbreak_dra_whitelist', 'example_callback');

function example_callback(array $whitelist): array {
     // Modify $whitelist and return string[]
    return $whitelist;
}
`

= Do I need this plugin? =

* [Disable REST API](https://wordpress.org/plugins/disable-json-api/) have planned to add whitelisting support which makes this plugin unnecessary. See [Dave McHale's comment](https://wordpress.org/support/topic/restrict-plug-in-use-of-rest-api/#post-9425207)
* If you have a legitimate need of the REST API, don't use  not need `Disable REST API` at all. See [Dave McHale's comment](https://wordpress.org/support/topic/restrict-plug-in-use-of-rest-api/#post-9367800)

= Requirements =

* PHP `7.0` or later
* WordPress `4.7` or later
* [Disable REST API](https://wordpress.org/plugins/disable-json-api/) `1.3` or later

> If you like the plugin, feel free to [rate it](https://wordpress.org/support/plugin/jailbreak-disable-json-api/reviews/#new-post) or [donate via PayPal](https://www.typist.tech/donate/jailbreak-disable-json-api/). Thanks a lot! :)

= For Bloggers =

If you have written an article about `Jailbreak Disable REST API`, do [let me know](https://www.typist.tech/contact/). For any questions, shoot me an email at [info@typist.tech](mailto:info@typist.tech)

= For Developers =

Jailbreak Disable REST API is open source and hosted on [GitHub](https://github.com/TypistTech/jailbreak-disable-json-api). Feel free to make [pull requests](https://github.com/TypistTech/jailbreak-disable-json-api/pulls).

= Who make this plugin? =

[Tang Rufus](mailto:info@typist.tech), a freelance developer for hire.
I make [Typist Tech](https://www.typist.tech/) also.

= Support =

To save time so that we can spend it on development, please read the plugin's [FAQs](https://wordpress.org/plugins/jailbreak-disable-json-api/faq/) first.
Before requesting support, and ensure that you have updated jailbreak-disable-json-api and WordPress to the latest released version and installed PHP 7 or later.

We hang out in the WordPress [support forum](https://wordpress.org/support/plugin/jailbreak-disable-json-api) for this plugin.

If you know what `GitHub` is, use [GitHub issues](https://github.com/TypistTech/jailbreak-disable-json-api/issues) instead.

== Installation ==

= Via WordPress admin dashboard =

1. Log in to your site’s Dashboard (e.g. www.your-domain.com/wp-admin)
1. Click on the `Plugins` tab in the left panel, then click “Add New”
1. Search for `Jailbreak Disable REST API` and the latest version will appear at the top of the list of results
1. Install it by clicking the `Install Now` link
1. When installation finishes, click `Activate Plugin`
1. Define 'JAILBREAK_DRA_WHITELIST' constant in `wp-config.php`

= Via Manual Upload =

1. Download the plugin from [wordpress.org](https://downloads.wordpress.org/plugin/jailbreak-disable-json-api.zip)
1. Unzip it
1. Upload it to `wp-content/plugins/`
1. Go to the WordPress plugin menu and activate it
1. Define 'JAILBREAK_DRA_WHITELIST' constant in `wp-config.php`

= Via WP CLI =

1. `$ wp plugin install jailbreak-disable-json-api --activate`
1. Define 'JAILBREAK_DRA_WHITELIST' constant in `wp-config.php`

== Frequently Asked Questions ==

= What version of PHP do I need? =

PHP `7.0` or later.

= What version of WordPress do I need? =

WordPress `4.7` or later.

= What to do when `Parse error: syntax error`? =

If you encountered this error:

`Parse error: syntax error, unexpected ‘:’, expecting ‘;’ or ‘{‘ in wp-content/plugins/jailbreak-disable-json-api/src/jailbreak-disable-json-api.php on line XX`

You probably running on a old version of PHP. Upgrade your server to PHP `7.0` or later.

= Don't know how to update PHP? =

* Contact you hosting company
* Switch to a better hosting such as [WP Engine](https://www.typist.tech/go/wp-engine-isnt-business-worth-29-month/) or [Kinsta](https://www.typist.tech/go/kinsta-staging-environment/)
* Hire me [https://www.typist.tech/contact](https://www.typist.tech/contact)

= Will you support older versions of PHP or WordPress? =

Depends. I accept this kind of custom coding jobs. However, I'll reject if the requirement doesn't make sense.
Shoot me an email at [info@typist.tech](mailto:info@typist.tech) or use this [contact form](https://www.typist.tech/contact/).

= Is this plugin written by Dave McHale, Disable REST API's author? =

No.
This plugin is a [Typist Tech](https://www.typist.tech) project.

= How to get support? =

Use the WordPress support forum for this plugin at [https://wordpress.org/support/plugin/jailbreak-disable-json-api](https://wordpress.org/support/plugin/jailbreak-disable-json-api).

Make sure you have read the plugin's FAQs at [https://wordpress.org/plugins/jailbreak-disable-json-api/faq/](https://wordpress.org/plugins/jailbreak-disable-json-api/faq/). And, updated jailbreak-disable-json-api and WordPress to the latest released version before asking questions.

If you know what `GitHub` is, use [GitHub issues](https://github.com/TypistTech/jailbreak-disable-json-api/issues) instead.

= How can I support this plugin? =

If you like the plugin, feel free to:

* Give us a 5-star review on [WordPress.org](https://wordpress.org/support/plugin/jailbreak-disable-json-api/reviews/#new-post)
* Donate via [PayPal](https://www.typist.tech/donate/jailbreak-disable-json-api/). Thanks a lot! :)

Besides, `jailbreak-disable-json-api` is open source and hosted on [GitHub](https://github.com/TypistTech/jailbreak-disable-json-api). Feel free to make pull requests.

Last but not least, you can hire me. Shoot me an email at [info@typist.tech](mailto:info@typist.tech) or use this [contact form](https://www.typist.tech/contact/).

= What if I want more? =

Hire me!

Shoot me an email at [info@typist.tech](mailto:info@typist.tech) or use this [contact form](https://www.typist.tech/contact/).

== Changelog ==

Full change log available at [GitHub](https://github.com/TypistTech/jailbreak-disable-json-api/blob/master/CHANGELOG.md)

= 0.1.3 =

* Fix deployment

= 0.1.2 =

* Readme: Add deprecated notice

= 0.1.1 =

* Readme: Add note about upcoming DRA whitlisting feature
* Readme: Fix markdown

= 0.1.0 =

* Initial release