Changeset 52133

Timestamp:

11/11/2021 03:50:22 AM (3 years ago)

Author:

noisysocks

Message:

REST API: Add /wp/v2/block-navigation-areas endpoint

Copies WP_REST_Block_Navigation_Areas_Controller from the Gutenberg plugin. This
provides the /wp/v2/block-navigation-areas endpoint used by the Navigation
block.

Props antonvlasenko, TimothyBlynJacobs.
Fixes #54393.

Location:

trunk

Files:

• src/wp-includes/default-filters.php (modified) (1 diff)
• src/wp-includes/navigation-areas.php (added)
• src/wp-includes/rest-api.php (modified) (1 diff)
• src/wp-includes/rest-api/endpoints/class-wp-rest-block-navigation-areas-controller.php (added)
• src/wp-settings.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api/rest-schema-setup.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/wpRestBlockNavigationAreasController.php (added)
• tests/qunit/fixtures/wp-api-generated.js (modified) (1 diff)

trunk/src/wp-includes/default-filters.php

@@ -670 +670 @@
 add_action( 'setup_theme', 'wp_enable_block_templates' );
 
+// Navigation areas.
+add_action( 'setup_theme', '_register_default_navigation_areas' );
+
 unset( $filter, $action );

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

@@ -349 +349 @@
     // Menu Locations.
     $controller = new WP_REST_Menu_Locations_Controller();
+    $controller->register_routes();
+
+    // Block Navigation Areas
+    $controller = new WP_REST_Block_Navigation_Areas_Controller();
     $controller->register_routes();
 }

trunk/src/wp-settings.php

@@ -245 +245 @@
 require ABSPATH . WPINC . '/class-wp-widget.php';
 require ABSPATH . WPINC . '/class-wp-widget-factory.php';
+require ABSPATH . WPINC . '/nav-menu-template.php';
 require ABSPATH . WPINC . '/nav-menu.php';
-require ABSPATH . WPINC . '/nav-menu-template.php';
+require ABSPATH . WPINC . '/navigation-areas.php';
 require ABSPATH . WPINC . '/admin-bar.php';
 require ABSPATH . WPINC . '/class-wp-application-passwords.php';
@@ -276 +277 @@
 require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-plugins-controller.php';
 require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-block-directory-controller.php';
+require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-block-navigation-areas-controller.php';
 require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php';
 require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-application-passwords-controller.php';

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

@@ -172 +172 @@
             '/wp/v2/navigation/(?P<parent>[\d]+)/revisions',
             '/wp/v2/navigation/(?P<parent>[\d]+)/revisions/(?P<id>[\d]+)',
+            '/wp/v2/block-navigation-areas',
+            '/wp/v2/block-navigation-areas/(?P<area>[\w-]+)',
             '/wp-site-health/v1',
             '/wp-site-health/v1/tests/background-updates',

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

@@ -10368 +10368 @@
                 }
             ]
+        },
+        "/wp/v2/block-navigation-areas": {
+            "namespace": "wp/v2",
+            "methods": [
+                "GET"
+            ],
+            "endpoints": [
+                {
+                    "methods": [
+                        "GET"
+                    ],
+                    "args": {
+                        "context": {
+                            "description": "Scope under which the request is made; determines fields present in response.",
+                            "type": "string",
+                            "enum": [
+                                "view",
+                                "embed",
+                                "edit"
+                            ],
+                            "default": "view",
+                            "required": false
+                        }
+                    }
+                }
+            ],
+            "_links": {
+                "self": [
+                    {
+                        "href": "http://example.org/index.php?rest_route=/wp/v2/block-navigation-areas"
+                    }
+                ]
+            }
+        },
+        "/wp/v2/block-navigation-areas/(?P<area>[\\w-]+)": {
+            "namespace": "wp/v2",
+            "methods": [
+                "GET",
+                "POST",
+                "PUT",
+                "PATCH"
+            ],
+            "endpoints": [
+                {
+                    "methods": [
+                        "GET"
+                    ],
+                    "allow_batch": {
+                        "v1": true
+                    },
+                    "args": {
+                        "area": {
+                            "description": "An alphanumeric identifier for the navigation area.",
+                            "type": "string",
+                            "required": false
+                        },
+                        "context": {
+                            "description": "Scope under which the request is made; determines fields present in response.",
+                            "type": "string",
+                            "enum": [
+                                "view",
+                                "embed",
+                                "edit"
+                            ],
+                            "default": "view",
+                            "required": false
+                        }
+                    }
+                },
+                {
+                    "methods": [
+                        "POST",
+                        "PUT",
+                        "PATCH"
+                    ],
+                    "allow_batch": {
+                        "v1": true
+                    },
+                    "args": {
+                        "area": {
+                            "description": "An alphanumeric identifier for the navigation area.",
+                            "type": "string",
+                            "required": false
+                        }
+                    }
+                }
+            ]
         }
     },