Changeset 47843

Timestamp:

05/22/2020 08:58:50 PM (6 years ago)

Author:

whyisjake

Message:

REST API: Ensure proper namespacing when registering routes.
The PR will corerce routes that have a leading slash and throwing a _doing_it_wrong notice while ensuring a proper namespace.

This brings the changes from [47842] to the 5.4 branch.

Fixes #49749.
Props TimothyBlynJacobs, skarabeq, afercia, skithund.

Location:

branches/5.4

Files:

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

branches/5.4/src/wp-includes/rest-api.php

@@ -45 +45 @@
         }
 
+        $clean_namespace = trim( $namespace, '/' );
+
+        if ( $clean_namespace !== $namespace ) {
+                _doing_it_wrong( __FUNCTION__, __( 'Namespace must not start or end with a slash.' ), '5.4.2' );
+        }
+
         if ( ! did_action( 'rest_api_init' ) ) {
                 _doing_it_wrong(
@@ -85 +91 @@
         }
 
-        $full_route = '/' . trim( $namespace, '/' ) . '/' . trim( $route, '/' );
-        rest_get_server()->register_route( $namespace, $full_route, $args, $override );
+        $full_route = '/' . $clean_namespace . '/' . trim( $route, '/' );
+        rest_get_server()->register_route( $clean_namespace, $full_route, $args, $override );
         return true;
 }

branches/5.4/tests/phpunit/tests/rest-api.php

@@ -955 +955 @@
         public function test_rest_parse_embed_param( $expected, $embed ) {
                 $this->assertEquals( $expected, rest_parse_embed_param( $embed ) );
+        }
+
+        /**
+         * @ticket 49749
+         */
+        public function test_register_route_with_invalid_namespace() {
+                $this->setExpectedIncorrectUsage( 'register_rest_route' );
+
+                register_rest_route(
+                        '/my-namespace/v1/',
+                        '/my-route',
+                        array(
+                                'callback' => '__return_true',
+                        )
+                );
+
+                $routes = rest_get_server()->get_routes( 'my-namespace/v1' );
+                $this->assertCount( 2, $routes );
+
+                $this->assertTrue( rest_do_request( '/my-namespace/v1/my-route' )->get_data() );
         }