Changeset 35651

Timestamp:

11/17/2015 02:38:31 AM (9 years ago)

Author:

rmccue

Message:

REST API: Require namespace when registering routes.

Props danielbachhuber.
Fixes #34416.

Location:

trunk

Files:

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

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

@@ -21 +21 @@
  * @param bool   $override  Optional. If the route already exists, should we override it? True overrides,
  *                          false merges (with newer overriding if duplicate keys exist). Default false.
+ * @return bool True on success, false on error.
  */
 function register_rest_route( $namespace, $route, $args = array(), $override = false ) {
     /** @var WP_REST_Server $wp_rest_server */
     global $wp_rest_server;
+
+    if ( empty( $namespace ) ) {
+        /*
+         * Non-namespaced routes are not allowed, with the exception of the main
+         * and namespace indexes. If you really need to register a
+         * non-namespaced route, call `WP_REST_Server::register_route` directly.
+         */
+        _doing_it_wrong( 'register_rest_route', 'Routes must be namespaced with plugin or theme name and version.', '4.4.0' );
+        return false;
+    } else if ( empty( $route ) ) {
+        _doing_it_wrong( 'register_rest_route', 'Route must be specified.', '4.4.0' );
+        return false;
+    }
 
     if ( isset( $args['callback'] ) ) {
@@ -45 +59 @@
     }
 
-    if ( $namespace ) {
-        $full_route = '/' . trim( $namespace, '/' ) . '/' . trim( $route, '/' );
-    } else {
-        /*
-         * Non-namespaced routes are not allowed, with the exception of the main
-         * and namespace indexes. If you really need to register a
-         * non-namespaced route, call `WP_REST_Server::register_route` directly.
-         */
-        _doing_it_wrong( 'register_rest_route', 'Routes must be namespaced with plugin name and version', '4.4.0' );
-
-        $full_route = '/' . trim( $route, '/' );
-    }
-
+    $full_route = '/' . trim( $namespace, '/' ) . '/' . trim( $route, '/' );
     $wp_rest_server->register_route( $namespace, $full_route, $args, $override );
+    return true;
 }
 

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

@@ -147 +147 @@
         $this->assertArrayHasKey( 'should_exist', $endpoint[0] );
         $this->assertTrue( $endpoint[0]['should_exist'] );
+    }
+
+    /**
+     * Test that we reject routes without namespaces
+     *
+     * @expectedIncorrectUsage register_rest_route
+     */
+    public function test_route_reject_empty_namespace() {
+        register_rest_route( '', '/test-empty-namespace', array(
+            'methods'      => array( 'POST' ),
+            'callback'     => '__return_null',
+        ), true );
+        $endpoints = $GLOBALS['wp_rest_server']->get_routes();
+        $this->assertFalse( isset( $endpoints['/test-empty-namespace'] ) );
+    }
+
+    /**
+     * Test that we reject empty routes
+     *
+     * @expectedIncorrectUsage register_rest_route
+     */
+    public function test_route_reject_empty_route() {
+        register_rest_route( '/test-empty-route', '', array(
+            'methods'      => array( 'POST' ),
+            'callback'     => '__return_null',
+        ), true );
+        $endpoints = $GLOBALS['wp_rest_server']->get_routes();
+        $this->assertFalse( isset( $endpoints['/test-empty-route'] ) );
     }