Changeset 41238

Timestamp:

08/10/2017 01:37:30 AM (8 years ago)

Author:

jnylen0

Message:

REST API: Always call rest_get_server() instead of accessing the $wp_rest_server global.

This is a consistency improvement and also a bug fix for fairly obscure cases involving modified WP load order.

Fixes #41555.

Location:

trunk

Files:

• src/wp-includes/rest-api.php (modified) (8 diffs)
• tests/phpunit/tests/rest-api.php (modified) (2 diffs)

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

@@ -19 +19 @@
  *
  * @since 4.4.0
- *
- * @global WP_REST_Server $wp_rest_server ResponseHandler instance (usually WP_REST_Server).
  *
  * @param string $namespace The first URL segment after core prefix. Should be unique to your package/plugin.
@@ -31 +29 @@
  */
 function register_rest_route( $namespace, $route, $args = array(), $override = false ) {
-    /** @var WP_REST_Server $wp_rest_server */
-    global $wp_rest_server;
-
     if ( empty( $namespace ) ) {
         /*
@@ -75 +70 @@
 
     $full_route = '/' . trim( $namespace, '/' ) . '/' . trim( $route, '/' );
-    $wp_rest_server->register_route( $namespace, $full_route, $args, $override );
+    rest_get_server()->register_route( $namespace, $full_route, $args, $override );
     return true;
 }
@@ -246 +241 @@
  *
  * @global WP             $wp             Current WordPress environment instance.
- * @global WP_REST_Server $wp_rest_server ResponseHandler instance (usually WP_REST_Server).
  */
 function rest_api_loaded() {
@@ -388 +382 @@
  * @since 4.4.0
  *
- * @global WP_REST_Server $wp_rest_server ResponseHandler instance (usually WP_REST_Server).
- *
  * @param WP_REST_Request|string $request Request.
  * @return WP_REST_Response REST response.
@@ -705 +697 @@
  *
  * @global mixed          $wp_rest_auth_cookie
- * @global WP_REST_Server $wp_rest_server      REST server instance.
  *
  * @param WP_Error|mixed $result Error from another authentication handler,
@@ -717 +708 @@
     }
 
-    global $wp_rest_auth_cookie, $wp_rest_server;
+    global $wp_rest_auth_cookie;
 
     /*
@@ -751 +742 @@
 
     // Send a refreshed nonce in header.
-    $wp_rest_server->send_header( 'X-WP-Nonce', wp_create_nonce( 'wp_rest' ) );
+    rest_get_server()->send_header( 'X-WP-Nonce', wp_create_nonce( 'wp_rest' ) );
 
     return true;

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

@@ -17 +17 @@
         // Override the normal server with our spying server.
         $GLOBALS['wp_rest_server'] = new Spy_REST_Server();
-        parent::setup();
+        parent::setUp();
+    }
+
+    public function tearDown() {
+        remove_filter( 'wp_rest_server_class', array( $this, 'filter_wp_rest_server_class' ) );
+        parent::tearDown();
     }
 
@@ -447 +452 @@
         $this->assertEquals( $value, rest_parse_date( $string, true ) );
     }
+
+    public function filter_wp_rest_server_class( $class_name ) {
+        return 'Spy_REST_Server';
+    }
+
+    public function test_register_rest_route_without_server() {
+        $GLOBALS['wp_rest_server'] = null;
+        add_filter( 'wp_rest_server_class', array( $this, 'filter_wp_rest_server_class' ) );
+
+        register_rest_route( 'test-ns', '/test', array(
+            'methods'  => array( 'GET' ),
+            'callback' => '__return_null',
+        ) );
+
+        $routes = $GLOBALS['wp_rest_server']->get_routes();
+        $this->assertEquals( $routes['/test-ns/test'][0]['methods'], array( 'GET' => true ) );
+    }
 }