Changeset 60359

Timestamp:

06/27/2025 08:45:08 PM (5 months ago)

Author:

johnbillion

Message:

Posts, Post Types: Correct the schema for the id property of the global styles REST API endpoint.

This property is an integer as it corresponds to a post ID.

Props narenin, TimothyBlynJacobs, audrasjb, johnbillion, mikinc860, abcd95

Fixes #61911

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php (modified) (6 diffs)
• tests/phpunit/tests/rest-api/rest-global-styles-controller.php (modified) (4 diffs)
• tests/phpunit/tests/rest-api/rest-schema-setup.php (modified) (1 diff)
• tests/qunit/fixtures/wp-api-generated.js (modified) (2 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php

@@ -89 +89 @@
         register_rest_route(
             $this->namespace,
-            '/' . $this->rest_base . '/(?P<id>[\/\w-]+)',
+            '/' . $this->rest_base . '/(?P<id>[\/\d+]+)',
             array(
                 array(
@@ -97 +97 @@
                     'args'                => array(
                         'id' => array(
-                            'description'       => __( 'The id of a template' ),
-                            'type'              => 'string',
-                            'sanitize_callback' => array( $this, '_sanitize_global_styles_callback' ),
+                            'description' => __( 'ID of global styles config.' ),
+                            'type'        => 'integer',
                         ),
                     ),
@@ -116 +115 @@
 
     /**
-     * Sanitize the global styles ID or stylesheet to decode endpoint.
+     * Sanitize the global styles stylesheet to decode endpoint.
      * For example, `wp/v2/global-styles/twentytwentytwo%200.4.0`
      * would be decoded to `twentytwentytwo 0.4.0`.
@@ -122 +121 @@
      * @since 5.9.0
      *
-     * @param string $id_or_stylesheet Global styles ID or stylesheet.
-     * @return string Sanitized global styles ID or stylesheet.
-     */
-    public function _sanitize_global_styles_callback( $id_or_stylesheet ) {
-        return urldecode( $id_or_stylesheet );
+     * @param string $stylesheet Global styles stylesheet.
+     * @return string Sanitized global styles stylesheet.
+     */
+    public function _sanitize_global_styles_callback( $stylesheet ) {
+        return urldecode( $stylesheet );
     }
 
@@ -140 +139 @@
         $error = new WP_Error(
             'rest_global_styles_not_found',
-            __( 'No global styles config exist with that id.' ),
+            __( 'No global styles config exists with that ID.' ),
             array( 'status' => 404 )
         );
@@ -465 +464 @@
                 'id'       => array(
                     'description' => __( 'ID of global styles config.' ),
-                    'type'        => 'string',
+                    'type'        => 'integer',
                     'context'     => array( 'embed', 'view', 'edit' ),
                     'readonly'    => true,

trunk/tests/phpunit/tests/rest-api/rest-global-styles-controller.php

@@ -134 +134 @@
         $routes = rest_get_server()->get_routes();
         $this->assertArrayHasKey(
-            '/wp/v2/global-styles/(?P<id>[\/\w-]+)',
+            '/wp/v2/global-styles/(?P<id>[\/\d+]+)',
             $routes,
             'Single global style based on the given ID route does not exist'
@@ -140 +140 @@
         $this->assertCount(
             2,
-            $routes['/wp/v2/global-styles/(?P<id>[\/\w-]+)'],
+            $routes['/wp/v2/global-styles/(?P<id>[\/\d+]+)'],
             'Single global style based on the given ID route does not have exactly two elements'
         );
@@ -409 +409 @@
             '2 subdirectories deep'  => array(
                 'theme_dirname' => 'subdir/subsubdir/mytheme',
-                'expected'      => 'rest_global_styles_not_found',
+                'expected'      => 'rest_no_route',
             ),
         );
@@ -777 +777 @@
         }
     }
+
+    /**
+     * Test that the route accepts integer IDs.
+     *
+     * @ticket 61911
+     */
+    public function test_global_styles_route_accepts_integer_id() {
+        wp_set_current_user( self::$admin_id );
+        $request  = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id );
+        $response = rest_get_server()->dispatch( $request );
+
+        $this->assertEquals( 200, $response->get_status() );
+
+        $data = $response->get_data();
+        $this->assertIsInt( $data['id'] );
+        $this->assertSame( self::$global_styles_id, $data['id'] );
+    }
+
+    /**
+     * Test that the schema defines ID as an integer.
+     *
+     * @ticket 61911
+     */
+    public function test_global_styles_schema_id_type() {
+        $request  = new WP_REST_Request( 'OPTIONS', '/wp/v2/global-styles/' . self::$global_styles_id );
+        $response = rest_get_server()->dispatch( $request );
+
+        $data   = $response->get_data();
+        $schema = $data['schema'];
+
+        $this->assertArrayHasKey( 'properties', $schema );
+        $this->assertArrayHasKey( 'id', $schema['properties'] );
+        $this->assertArrayHasKey( 'type', $schema['properties']['id'] );
+        $this->assertSame( 'integer', $schema['properties']['id']['type'] );
+    }
+
+    /**
+     * Test that the route argument schema defines ID as an integer.
+     *
+     * @ticket 61911
+     */
+    public function test_global_styles_route_args_schema() {
+        $routes     = rest_get_server()->get_routes();
+        $route_data = $routes['/wp/v2/global-styles/(?P<id>[\/\d+]+)'];
+
+        $this->assertArrayHasKey( 'args', $route_data[0] );
+        $this->assertArrayHasKey( 'id', $route_data[0]['args'] );
+        $this->assertArrayHasKey( 'type', $route_data[0]['args']['id'] );
+        $this->assertSame( 'integer', $route_data[0]['args']['id']['type'] );
+    }
 }

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

@@ -134 +134 @@
             '/wp/v2/comments',
             '/wp/v2/comments/(?P<id>[\\d]+)',
-            '/wp/v2/global-styles/(?P<id>[\/\w-]+)',
+            '/wp/v2/global-styles/(?P<id>[\/\d+]+)',
             '/wp/v2/global-styles/(?P<parent>[\d]+)/revisions',
             '/wp/v2/global-styles/(?P<parent>[\d]+)/revisions/(?P<id>[\d]+)',

trunk/tests/qunit/fixtures/wp-api-generated.js

@@ -6897 +6897 @@
             ]
         },
-        "/wp/v2/global-styles/(?P<id>[\\/\\w-]+)": {
+        "/wp/v2/global-styles/(?P<id>[\\/\\d+]+)": {
             "namespace": "wp/v2",
             "methods": [
@@ -6915 +6915 @@
                     "args": {
                         "id": {
-                            "description": "The id of a template",
-                            "type": "string",
+                            "description": "ID of global styles config.",
+                            "type": "integer",
                             "required": false
                         }