Changeset 59457

Timestamp:

11/25/2024 10:08:05 AM (22 months ago)

Author:

swissspidy

Message:

REST API: Remove trailing slashes when preloading requests and there is a query string.

Follow-up to [51648], see #51636.

Props antonvlasenko, swissspidy, spacedmonkey.
Fixes #57048.

Location:

trunk

Files:

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

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

@@ -2936 +2936 @@
         }
 
+        // Remove trailing slashes at the end of the REST API path (query part).
         $path = untrailingslashit( $path );
         if ( empty( $path ) ) {
@@ -2944 +2945 @@
         if ( false === $path_parts ) {
                 return $memo;
+        }
+
+        if ( isset( $path_parts['path'] ) && '/' !== $path_parts['path'] ) {
+                // Remove trailing slashes from the "path" part of the REST API path.
+                $path_parts['path'] = untrailingslashit( $path_parts['path'] );
+                $path               = str_contains( $path, '?' ) ?
+                        $path_parts['path'] . '?' . ( $path_parts['query'] ?? '' ) :
+                        $path_parts['path'];
         }
 

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

@@ -961 +961 @@
 
         /**
+         * @dataProvider data_rest_preload_api_request_removes_trailing_slashes
+         *
          * @ticket 51636
-         */
-        public function test_rest_preload_api_request_removes_trailing_slashes() {
+         * @ticket 57048
+         *
+         * @param string       $preload_path          The path to preload.
+         * @param array|string $expected_preload_path Expected path after preloading.
+         */
+        public function test_rest_preload_api_request_removes_trailing_slashes( $preload_path, $expected_preload_path ) {
                 $rest_server               = $GLOBALS['wp_rest_server'];
                 $GLOBALS['wp_rest_server'] = null;
 
-                $preload_paths = array(
-                        '/wp/v2/types//',
-                        array( '/wp/v2/media///', 'OPTIONS' ),
-                        '////',
-                );
-
-                $preload_data = array_reduce(
-                        $preload_paths,
-                        'rest_preload_api_request',
-                        array()
-                );
-
-                $this->assertSame( array_keys( $preload_data ), array( '/wp/v2/types', 'OPTIONS', '/' ) );
-                $this->assertArrayHasKey( '/wp/v2/media', $preload_data['OPTIONS'] );
+                $actual_preload_path = rest_preload_api_request( array(), $preload_path );
+                if ( '' !== $preload_path ) {
+                        $actual_preload_path = key( $actual_preload_path );
+                }
+                $this->assertSame( $expected_preload_path, $actual_preload_path );
 
                 $GLOBALS['wp_rest_server'] = $rest_server;
+        }
+
+        /**
+         * Data provider.
+         *
+         * @return array
+         */
+        public static function data_rest_preload_api_request_removes_trailing_slashes() {
+                return array(
+                        'no query part'                     => array( '/wp/v2/types//', '/wp/v2/types' ),
+                        'no query part, more slashes'       => array( '/wp/v2/media///', '/wp/v2/media' ),
+                        'only slashes'                      => array( '////', '/' ),
+                        'empty path'                        => array( '', array() ),
+                        'no query parameters'               => array( '/wp/v2/types//?////', '/wp/v2/types?' ),
+                        'no query parameters, with slashes' => array( '/wp/v2/types//?fields////', '/wp/v2/types?fields' ),
+                        'query parameters with no values'   => array( '/wp/v2/types//?fields=////', '/wp/v2/types?fields=' ),
+                        'single query parameter'            => array( '/wp/v2/types//?_fields=foo,bar////', '/wp/v2/types?_fields=foo,bar' ),
+                        'multiple query parameters'         => array( '/wp/v2/types////?_fields=foo,bar&limit=1000////', '/wp/v2/types?_fields=foo,bar&limit=1000' ),
+                );
         }