Changeset 36829

Timestamp:

03/03/2016 09:54:32 AM (9 years ago)

Author:

joehoyle

Message:

OPTIONS requests to REST API should return Allow header.

An OPTIONS request was incorrectly returning an "Accept" header which
was a typo of "Allow". This meant Accept was showing "GET, POST" for example,
however it was also not running the permission checks on the endpoints.

Instead, the correct route needs to be set on the request object, which means
the normal handling for the Allow header will kick in. This technically
breaks backwards compatibility, however given the value of Accept was also wrong
then this should not be an issue.

Fixes #35975.

Location:

trunk

Files:

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

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

@@ -432 +432 @@
 
         $data = $handler->get_data_for_route( $route, $endpoints, 'help' );
-        $accept = array_merge( $accept, $data['methods'] );
+        $response->set_matched_route( $route );
         break;
     }
-    $response->header( 'Accept', implode( ', ', $accept ) );
 
     $response->set_data( $data );

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

@@ -286 +286 @@
     }
 
+    public function test_allow_header_sent_on_options_request() {
+        register_rest_route( 'test-ns', '/test', array(
+            array(
+                'methods'  => array( 'GET' ),
+                'callback' => '__return_null',
+            ),
+            array(
+                'methods'  => array( 'POST' ),
+                'callback' => '__return_null',
+                'permission_callback' => '__return_null',
+            ),
+        ) );
+
+        $request = new WP_REST_Request( 'OPTIONS', '/test-ns/test' );
+        $response = $this->server->dispatch( $request );
+
+        $result = apply_filters( 'rest_post_dispatch', rest_ensure_response( $response ), $this->server, $request );
+
+        $headers = $result->get_headers();
+
+        $this->assertEquals( 'GET', $headers['Allow'] );
+    }
+
     public function permission_denied() {
         return new WP_Error( 'forbidden', 'You are not allowed to do this', array( 'status' => 403 ) );