Changeset 38947

Timestamp:

10/26/2016 06:27:04 AM (8 years ago)

Author:

pento

Message:

REST API: Deprecate the rest_enabled filter.

As the REST API becomes more integral to WordPress Core, turning it off will cause a... suboptimal experience. If we don't want it to be turned off, the off switch needs to be removed.

Props jorbin, pento.
Fixes #38446.

Location:

trunk

Files:

• src/wp-includes/rest-api/class-wp-rest-server.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api/rest-server.php (modified) (1 diff)

trunk/src/wp-includes/rest-api/class-wp-rest-server.php

@@ -261 +261 @@
          *
          * @since 4.4.0
+         * @deprecated 4.7.0 Use the rest_authentication_errors filter to restrict access to the API
          *
          * @param bool $rest_enabled Whether the REST API is enabled. Default true.
          */
-        $enabled = apply_filters( 'rest_enabled', true );
+        apply_filters_deprecated( 'rest_enabled', array( true ), '4.7.0', 'rest_authentication_errors', __( 'The REST API can no longer be completely disabled, the rest_authentication_errors can be used to restrict access to the API, instead.' ) );
 
         /**
@@ -277 +278 @@
         $jsonp_callback = null;
 
-        if ( ! $enabled ) {
-            echo $this->json_error( 'rest_disabled', __( 'The REST API is disabled on this site.' ), 404 );
-            return false;
-        }
         if ( isset( $_GET['_jsonp'] ) ) {
             if ( ! $jsonp_enabled ) {

trunk/tests/phpunit/tests/rest-api/rest-server.php

@@ -726 +726 @@
 
         $this->assertEquals( 'noindex', $headers['X-Robots-Tag'] );
+    }
+
+    /**
+     * @ticket 38446
+     * @expectedDeprecated rest_enabled
+     */
+    public function test_rest_enable_filter_is_deprecated() {
+        add_filter( 'rest_enabled', '__return_false' );
+        $this->server->serve_request( '/' );
+        remove_filter( 'rest_enabled', '__return_false' );
+
+        $result = json_decode( $this->server->sent_body );
+
+        $this->assertObjectNotHasAttribute( 'code', $result );
     }