Changeset 52051

Timestamp:

11/08/2021 08:58:56 PM (3 years ago)

Author:

jorgefilipecosta

Message:

Add: Global Styles Rest endpoints.

This commit ports the global styles rest endpoints from the Gutenberg plugin into the core.

See #54336.
Props oandregal, aristath, timothyblynjacobs, spacedmonkey, youknowriad.

Location:

trunk

Files:

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

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

@@ -300 +300 @@
     // Block Types.
     $controller = new WP_REST_Block_Types_Controller();
+    $controller->register_routes();
+
+    // Global Styles.
+    $controller = new WP_REST_Global_Styles_Controller;
     $controller->register_routes();
 

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

@@ -317 +317 @@
         $response->add_links( $this->prepare_links( $theme ) );
 
+        if ( $theme->get_stylesheet() === wp_get_theme()->get_stylesheet() ) {
+            // This creates a record for the current theme if not existent.
+            $id = WP_Theme_JSON_Resolver::get_user_custom_post_type_id();
+        } else {
+            $wp_query_args       = array(
+                'post_status'    => 'publish',
+                'post_type'      => 'wp_global_styles',
+                'posts_per_page' => 1,
+                'no_found_rows'  => true,
+                'fields'         => 'ids',
+                'tax_query'      => array(
+                    array(
+                        'taxonomy' => 'wp_theme',
+                        'field'    => 'name',
+                        'terms'    => $theme->get_stylesheet(),
+                    ),
+                ),
+            );
+            $global_styles_query = new WP_Query( $wp_query_args );
+            $id                  = ! empty( $global_styles_query->posts ) ? array_shift( $global_styles_query->posts ) : null;
+        }
+
+        if ( $id ) {
+            $response->add_link(
+                'https://api.w.org/user-global-styles',
+                rest_url( 'wp/v2/global-styles/' . $id )
+            );
+        }
+
         /**
          * Filters theme data returned from the REST API.

trunk/src/wp-settings.php

@@ -255 +255 @@
 require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-posts-controller.php';
 require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-attachments-controller.php';
+require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-global-styles-controller.php';
 require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-post-types-controller.php';
 require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-post-statuses-controller.php';

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

@@ -125 +125 @@
             '/wp/v2/comments',
             '/wp/v2/comments/(?P<id>[\\d]+)',
+            '/wp/v2/global-styles/(?P<id>[\/\w-]+)',
+            '/wp/v2/global-styles/themes/(?P<stylesheet>[^.\/]+(?:\/[^.\/]+)?)',
             '/wp/v2/search',
             '/wp/v2/block-renderer/(?P<name>[a-z0-9-]+/[a-z0-9-]+)',

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

@@ -6561 +6561 @@
             ]
         },
+        "/wp/v2/global-styles/themes/(?P<stylesheet>[^.\\/]+(?:\\/[^.\\/]+)?)": {
+            "namespace": "wp/v2",
+            "methods": [
+                "GET"
+            ],
+            "endpoints": [
+                {
+                    "methods": [
+                        "GET"
+                    ],
+                    "args": {
+                        "stylesheet": {
+                            "description": "The theme identifier",
+                            "type": "string",
+                            "required": false
+                        }
+                    }
+                }
+            ]
+        },
+        "/wp/v2/global-styles/(?P<id>[\\/\\w-]+)": {
+            "namespace": "wp/v2",
+            "methods": [
+                "GET",
+                "POST",
+                "PUT",
+                "PATCH"
+            ],
+            "endpoints": [
+                {
+                    "methods": [
+                        "GET"
+                    ],
+                    "args": {
+                        "id": {
+                            "description": "The id of a template",
+                            "type": "string",
+                            "required": false
+                        }
+                    }
+                },
+                {
+                    "methods": [
+                        "POST",
+                        "PUT",
+                        "PATCH"
+                    ],
+                    "args": {
+                        "styles": {
+                            "description": "Global styles.",
+                            "type": [
+                                "object"
+                            ],
+                            "required": false
+                        },
+                        "settings": {
+                            "description": "Global settings.",
+                            "type": [
+                                "object"
+                            ],
+                            "required": false
+                        },
+                        "title": {
+                            "description": "Title of the global styles variation.",
+                            "type": [
+                                "object",
+                                "string"
+                            ],
+                            "properties": {
+                                "raw": {
+                                    "description": "Title for the global styles variation, as it exists in the database.",
+                                    "type": "string",
+                                    "context": [
+                                        "view",
+                                        "edit",
+                                        "embed"
+                                    ]
+                                },
+                                "rendered": {
+                                    "description": "HTML title for the post, transformed for display.",
+                                    "type": "string",
+                                    "context": [
+                                        "view",
+                                        "edit",
+                                        "embed"
+                                    ],
+                                    "readonly": true
+                                }
+                            },
+                            "required": false
+                        }
+                    }
+                }
+            ]
+        },
         "/wp/v2/settings": {
             "namespace": "wp/v2",