WordPress.org

وۆردپرێس بەکوردی

وۆردپرێس بە دەستبێنە
WordPress.org

Plugin Directory

Disable WP REST API

Image

Disable WP REST API

لەلایەن Jeff Starr
داگرتن

وەسف

Does one thing: Completely disables the WordPress REST API for visitors who are not logged into WordPress. No configuration required.

Important: This plugin completely disables the WP REST API for visitors who are NOT logged in to WordPress. So not recommended if your site needs the WP REST API for any non-logged users.

👉 The fast, simple way to prevent abuse of your site’s REST/JSON API
👉 Protects your site’s REST data from all non-logged users and bots
👉 Uses only 4KB of code, so super lightweight, fast, and effective

🛠️ Pro version available! Check out REST Pro Tools »

Features

  • Disable REST/JSON for visitors (not logged in)
  • Disables REST header in HTTP response for all users
  • Disables REST links in HTML head for all users
  • 100% plug-and-play, set-it-and-forget solution

How does it work?

This plugin completely disables the WP REST API unless the user is logged into WordPress.

  • For logged-in (authenticated) users, WP REST API works normally
  • For logged-out (unauthenticated) users, WP REST API is disabled

What happens if logged-out visitor makes a JSON/REST request? They will get only a simple message:

rest_login_required: REST API restricted to authenticated users.

This message may customized via the filter hook, disable_wp_rest_api_error. Check out this post for an example of how to do it.

Pro Version

🛠️ Check out the Pro version, REST Pro Tools, loaded with many awesome features:

  • One-click disable all routes
  • One-click disable all /users routes
  • Disable any specific user routes based on role
  • Whitelist any user IDs
  • Whitelist any IP addresses
  • Customize the REST error message
  • Customize the REST response code
  • Always require or force SSL/TLS
  • Disable all JSONP shenanigans
  • One-click disable any REST API headers
  • Add any post meta (custom field) to REST API
  • Add any user meta (custom field) to REST API
  • Add routes for site profile and author profile
  • Add routes for featured images and post categories
  • Add routes for post taxonomies and terms
  • At-a-glance check status of REST API

The free version does only one thing: disables REST API for unauthenticated users. The PRO version can do that and much more! Take full control of the REST API with REST Pro Tools »

Privacy

This plugin does not collect or store any user data. It does not set any cookies, and it does not connect to any third-party locations. Thus, this plugin does not affect user privacy in any way. If anything it improves user privacy, as it protects potentially sensitive information from being displayed/accessed via REST API.

Disable WP REST API is developed and maintained by Jeff Starr, 15-year WordPress developer and book author.

Support development of this plugin

I develop and maintain this free plugin with love for the WordPress community. To show support, you can make a donation or purchase one of my books:

And/or purchase one of my premium WordPress plugins:

Links, tweets and likes also appreciated. Thank you! 🙂

دامەزراندن

How to Install

  1. Upload the plugin to your blog and activate
  2. Done! No further configuration is required.

More info on installing WP plugins

Testing

To test that the plugin is working, log out of WordPress and then request https://example.com/wp-json/ in a browser. See FAQs for more infos.

Pro Version

Need more control of the WP REST API? Check out the Pro version »

Like the plugin?

If you like Disable WP REST API, please take a moment to give a 5-star rating. It helps to keep development and support going strong. Thank you!

Uninstalling

To uninstall/remove the plugin, visit the Plugins screen, deactivate and delete the plugin. This plugin makes no changes to the WP database.

پهد

Why would anyone want to disable the REST API?

Technically this plugin disables REST API only for visitors who are not logged into WordPress. With that in mind, here are some good reasons why someone would want to disable REST API for non-logged users:

  • The REST API may not be needed for non-logged users
  • Disabling the REST API conserves server resources
  • Disabling the REST API minimizes potential attack vectors
  • Disabling the REST API prevents content scraping and plagiarism

I’m sure there are other valid reasons, but you get the idea 🙂

What is the default access-denied message?

When the user is logged in to WordPress, the normal REST API data will be displayed. When the user is not logged in, this is the default message:

{"code":"rest_login_required","message":"REST API restricted to authenticated users.","data":{"status":401}}

How do I test that REST is disabled?

Testing is easy:

  1. Log out of WordPress
  2. Using a browser, request https://example.com/wp-json/

If you see the following message, REST is disabled:

“rest_login_required: REST API restricted to authenticated users.”

Then if you log back in and make a new request for https://example.com/wp-json/, you will see that REST is working normally.

Does it disable REST functionality added by other plugins?

Yes. If the user is NOT logged in, this plugin disables ALL endpoints that are registered with the WP REST API. Otherwise, if the user IS logged in, then this plugin does not block anything.

Does this work with Gutenberg/Block Editor?

Yes. It works the same regardless of which editor (Classic or Block) you are using.

How to customize the error message?

By default the plugin displays a message for unauthenticated users: “REST API restricted to authenticated users.” To customize that message to whatever you want, add the following code via functions.php or simple custom plugin:

function disable_wp_rest_api_error_custom($message) {

    return 'Customize your message here.'; // change this to whatever you want

}
add_filter('disable_wp_rest_api_error', 'disable_wp_rest_api_error_custom');

How to allow access for Contact Form 7?

As explained in this thread, the plugin Contact Form 7 requires REST API access in order for the contact form to work. To allow for this, follow this guide.

Got a question?

Send any questions or feedback via my contact form

پێداچوونەوەکان

Image

I like it!

ئایار 6, 2024
I’ve tried many different solutions using functions.php because I did not want to install yet another plugin. I’m glad I found this one though. It’s simple, lightweight, maintains privacy, and functions with the latest version of WordPress. Thanks Jeff!
Image

Good Stuff – but make many other things more complicate

ئازار 29, 2023
In generel a Good security concept . But at the other end many plugin developer use the Rest API Could be done much easier with a 5 3 line htaccess rule to block only ^.*wp-json/wp/v2/(users But anyway a good solution if you have a simpel installation.
خوێندنەوەی 36 پێداچوونەوە

بەشداربووان و گەشەپێدەران

“Disable WP REST API” نەرمەواڵەیەکی سەرچاوە کراوەیە. ئەم کەسانەی خوارەوە بەشدارییان تێدا کردووە.

بەشداربووان

“Disable WP REST API” وەرگێڕدراوە بۆ 8 زمان. سوپاسی وەرگێڕەکان دەکەین بۆ بەشداریکردنیان.

“Disable WP REST API” وەربگێڕە بۆ زمانەکەی خۆت.

دەتەوێت بەشداربیت لە گەشەپێدان؟

گەڕان لە کۆدەکەدا بکە، سەیری تەمارگەی (SVN) بکە، یان بەشداربە لە ڕووداوتۆماری گەشەپێدان لە ڕێگەی (RSS).

ڕووداوتۆمارگەریی گۆڕین

If you like Disable WP REST API, please take a moment to give a 5-star rating. It helps to keep development and support going strong. Thank you!

🛠️ Pro version now available! Get granular control over the REST API with REST Pro Tools »

2.6.8

  • Improves readme.txt documentation
  • Adds blurb about new pro version
  • Tests on WordPress 7.0

Full changelog @ https://plugin-planet.com/wp/changelog/disable-wp-rest-api.txt

مێتا

هەڵسەنگاندنەکان

4.8 out of 5 stars.

Your review

See all reviews

بەشداربووان

پشتیوانی

هیچت هەیە بۆ وتن؟ پێویستت بە یارمەتییە؟

بینینی مەکۆی پاڵپشتی

ببەخشە

دەتەوێت پشتگیریی بەرەوپێشچوونی ئەم پێوەکراوە بکەیت؟

ببەخشە بەم پێوەکراوە