Changeset 48173

Timestamp:

06/26/2020 12:44:44 AM (4 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Introduce Block Types endpoint.

This endpoint allows a user to retrieve the block type definition for all server-side registered block types.

Props spacedmonkey, aduth, gziolo, ocean90, TimothyBlynJacobs.
Fixes #47620.

Location:

trunk

Files:

• src/wp-includes/class-wp-block-styles-registry.php (modified) (1 diff)
• src/wp-includes/rest-api.php (modified) (1 diff)
• src/wp-includes/rest-api/endpoints/class-wp-rest-block-types-controller.php (added)
• src/wp-settings.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-block-type-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/class-wp-block-styles-registry.php

@@ -35 +35 @@
      * @since 5.3.0
      *
-     * @param string $block_name       Block type name including namespace.
+     * @param string $block_name       Block ty name including namespace.
      * @param array  $style_properties Array containing the properties of the style name, label,
      *                                 style (name of the stylesheet to be enqueued),

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

@@ -272 +272 @@
     // Block Renderer.
     $controller = new WP_REST_Block_Renderer_Controller;
+    $controller->register_routes();
+
+    // Block Types.
+    $controller = new WP_REST_Block_Types_Controller();
     $controller->register_routes();
 

trunk/src/wp-settings.php

@@ -254 +254 @@
 require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-search-controller.php';
 require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-blocks-controller.php';
+require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-block-types-controller.php';
 require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-block-renderer-controller.php';
 require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-settings-controller.php';

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

@@ -122 +122 @@
             '/wp/v2/search',
             '/wp/v2/block-renderer/(?P<name>[a-z0-9-]+/[a-z0-9-]+)',
+            '/wp/v2/block-types',
+            '/wp/v2/block-types/(?P<namespace>[a-zA-Z0-9_-]+)',
+            '/wp/v2/block-types/(?P<namespace>[a-zA-Z0-9_-]+)/(?P<name>[a-zA-Z0-9_-]+)',
             '/wp/v2/settings',
             '/wp/v2/themes',

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

@@ -4432 +4432 @@
                             "description": "ID of the post context.",
                             "type": "integer"
+                        }
+                    }
+                }
+            ]
+        },
+        "/wp/v2/block-types": {
+            "namespace": "wp/v2",
+            "methods": [
+                "GET"
+            ],
+            "endpoints": [
+                {
+                    "methods": [
+                        "GET"
+                    ],
+                    "args": {
+                        "context": {
+                            "required": false,
+                            "default": "view",
+                            "enum": [
+                                "view",
+                                "embed",
+                                "edit"
+                            ],
+                            "description": "Scope under which the request is made; determines fields present in response.",
+                            "type": "string"
+                        },
+                        "namespace": {
+                            "required": false,
+                            "description": "Block namespace.",
+                            "type": "string"
+                        }
+                    }
+                }
+            ],
+            "_links": {
+                "self": [
+                    {
+                        "href": "http://example.org/index.php?rest_route=/wp/v2/block-types"
+                    }
+                ]
+            }
+        },
+        "/wp/v2/block-types/(?P<namespace>[a-zA-Z0-9_-]+)": {
+            "namespace": "wp/v2",
+            "methods": [
+                "GET"
+            ],
+            "endpoints": [
+                {
+                    "methods": [
+                        "GET"
+                    ],
+                    "args": {
+                        "context": {
+                            "required": false,
+                            "default": "view",
+                            "enum": [
+                                "view",
+                                "embed",
+                                "edit"
+                            ],
+                            "description": "Scope under which the request is made; determines fields present in response.",
+                            "type": "string"
+                        },
+                        "namespace": {
+                            "required": false,
+                            "description": "Block namespace.",
+                            "type": "string"
+                        }
+                    }
+                }
+            ]
+        },
+        "/wp/v2/block-types/(?P<namespace>[a-zA-Z0-9_-]+)/(?P<name>[a-zA-Z0-9_-]+)": {
+            "namespace": "wp/v2",
+            "methods": [
+                "GET"
+            ],
+            "endpoints": [
+                {
+                    "methods": [
+                        "GET"
+                    ],
+                    "args": {
+                        "name": {
+                            "required": false,
+                            "description": "Block name",
+                            "type": "string"
+                        },
+                        "namespace": {
+                            "required": false,
+                            "description": "Block namespace",
+                            "type": "string"
+                        },
+                        "context": {
+                            "required": false,
+                            "default": "view",
+                            "enum": [
+                                "view",
+                                "embed",
+                                "edit"
+                            ],
+                            "description": "Scope under which the request is made; determines fields present in response.",
+                            "type": "string"
                         }
                     }