Changeset 59718 for trunk/tests/phpunit/tests/rest-api/wpRestMenuLocationsController.php

Timestamp:

01/28/2025 04:07:07 AM (6 months ago)

Author:

spacedmonkey

Message:

REST API: Introduce filter for controlling menu read access.

The menu, menu item, and menu location endpoints were added to the REST API in [52079]. In that commit, menu data was treated as private and restricted to logged-in users with the edit_theme_options capability. However, in many cases, this data can be considered public. Previously, there was no simple way for developers to allow this data to be exposed via the REST API.

This commit introduces the rest_menu_read_access filter, enabling developers to control read access to menus, menu items, and menu locations in the REST API. The same filter is applied across all three REST API classes, simplifying the process of opting into exposing this data.

Each instance of the filter provides the current request and the relevant class instance as context, allowing developers to selectively or globally enable access to the data.

Props spacedmonkey, antonvlasenko, kadamwhite, julianmar, masteradhoc.
Fixes #54304.

File:

• trunk/tests/phpunit/tests/rest-api/wpRestMenuLocationsController.php (modified) (1 diff)

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

@@ -122 +122 @@
 
     /**
+     * @ticket 54304
+     * @covers ::get_items
+     */
+    public function test_get_items_filter() {
+        $menus = array( 'primary', 'secondary' );
+        $this->register_nav_menu_locations( array( 'primary', 'secondary' ) );
+        add_filter( 'rest_menu_read_access', '__return_true' );
+
+        $request  = new WP_REST_Request( 'GET', '/wp/v2/menu-locations' );
+        $response = rest_get_server()->dispatch( $request );
+        $data     = $response->get_data();
+        $data     = array_values( $data );
+        $this->assertCount( 2, $data, 'Number of menu location are not 2' );
+
+        $names        = wp_list_pluck( $data, 'name' );
+        $descriptions = wp_list_pluck( $data, 'description' );
+        $this->assertSame( $menus, $names );
+        $menu_descriptions = array_map( 'ucfirst', $names );
+
+        $this->assertSame( $menu_descriptions, $descriptions, 'Menu descriptions do not match' );
+    }
+
+    /**
+     * @ticket 54304
+     * @covers ::get_item
+     */
+    public function test_get_item_filter() {
+        $menu = 'primary';
+        $this->register_nav_menu_locations( array( $menu ) );
+
+        add_filter( 'rest_menu_read_access', '__return_true' );
+        $request  = new WP_REST_Request( 'GET', '/wp/v2/menu-locations/' . $menu );
+        $response = rest_get_server()->dispatch( $request );
+        $data     = $response->get_data();
+
+        $this->assertSame( $menu, $data['name'] );
+    }
+
+    /**
      * @ticket 40878
      * @covers ::get_item