Changeset 60073

Timestamp:

03/24/2025 11:57:08 PM (2 months ago)

Author:

audrasjb

Message:

REST API: exclude rest_route from get_params() if pretty permalinks are disabled.

This changeset introduces a modification to the get_params() method within the WordPress REST API. The change ensures that the rest_route parameter is excluded from the parameters returned when pretty permalinks are not enabled. This update enhances the developer experience by ensuring that the parameters returned by get_params() are relevant and do not include unnecessary values, thereby reducing potential confusion and errors.

Props westonruter, TimothyBlynJacobs, audrasjb, debarghyabanerjee, dilip2615, shanemuir, peterwilsoncc.
Fixes #62163.

Location:

trunk

Files:

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

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

@@ -495 +495 @@
         }
 
+        // Exclude rest_route if pretty permalinks are not enabled.
+        if ( ! get_option( 'permalink_structure' ) ) {
+            unset( $params['rest_route'] );
+        }   
+
         return $params;
     }

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

@@ -1127 +1127 @@
         );
     }
+
+    /**
+     * @ticket 62163
+     */
+    public function test_get_params_without_pretty_permalink() {
+        update_option( 'permalink_structure', '' );
+
+        $request = new WP_REST_Request();
+        $request->set_param( 'rest_route', '/wp/v2/posts' );
+        $request->set_param( 'some_param', 'foobar' );
+
+        $params = $request->get_params();
+
+        $this->assertArrayNotHasKey( 'rest_route', $params );
+        $this->assertArrayHasKey( 'some_param', $params );
+    }
+
+    /**
+     * @ticket 62163
+     */
+    public function test_get_params_with_pretty_permalinks() {
+        update_option( 'permalink_structure', '/%postname%/' );
+
+        $request = new WP_REST_Request();
+
+        $request->set_param( 'rest_route', '/wp/v2/posts' );
+        $request->set_param( 'some_param', 'foobar' );
+
+        $params = $request->get_params();
+
+        $this->assertArrayHasKey( 'rest_route', $params );
+        $this->assertArrayHasKey( 'some_param', $params );
+    }
 }