<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[59718] trunk: REST API: Introduce filter for controlling menu read access.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/59718">59718</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/59718","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>spacedmonkey</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2025-01-28 04:07:07 +0000 (Tue, 28 Jan 2025)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>REST API: Introduce filter for controlling menu read access.
The menu, menu item, and menu location endpoints were added to the REST API in <a href="https://core.trac.wordpress.org/changeset/52079">[52079]</a>. 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 <a href="https://core.trac.wordpress.org/ticket/54304">#54304</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestmenuitemscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestmenulocationscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menu-locations-controller.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestmenuscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapiwpRestMenuItemsControllerphp">trunk/tests/phpunit/tests/rest-api/wpRestMenuItemsController.php</a></li>
<li><a href="#trunktestsphpunittestsrestapiwpRestMenuLocationsControllerphp">trunk/tests/phpunit/tests/rest-api/wpRestMenuLocationsController.php</a></li>
<li><a href="#trunktestsphpunittestsrestapiwpRestMenusControllerphp">trunk/tests/phpunit/tests/rest-api/wpRestMenusController.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestmenuitemscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php 2025-01-28 03:48:40 UTC (rev 59717)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php 2025-01-28 04:07:07 UTC (rev 59718)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -80,6 +80,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return true|WP_Error True if the request has read access for the item, WP_Error object otherwise.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function check_has_read_only_access( $request ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters whether the current user has read access to menu items via the REST API.
+ *
+ * @since 6.8.0
+ * @param $read_only_access bool Whether the current user has read access to menu items via the REST API.
+ * @param $request WP_REST_Request Full details about the request.
+ * @param $this WP_REST_Controller The current instance of the controller.
+ */
+ $read_only_access = apply_filters( 'rest_menu_read_access', false, $request, $this );
+ if ( $read_only_access ) {
+ return true;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( current_user_can( 'edit_theme_options' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswprestmenulocationscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menu-locations-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menu-locations-controller.php 2025-01-28 03:48:40 UTC (rev 59717)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menu-locations-controller.php 2025-01-28 04:07:07 UTC (rev 59718)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -80,15 +80,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return true|WP_Error True if the request has read access, WP_Error object otherwise.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_items_permissions_check( $request ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! current_user_can( 'edit_theme_options' ) ) {
- return new WP_Error(
- 'rest_cannot_view',
- __( 'Sorry, you are not allowed to view menu locations.' ),
- array( 'status' => rest_authorization_required_code() )
- );
- }
-
- return true;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $this->check_has_read_only_access( $request );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -123,15 +115,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return true|WP_Error True if the request has read access for the item, WP_Error object otherwise.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_item_permissions_check( $request ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! current_user_can( 'edit_theme_options' ) ) {
- return new WP_Error(
- 'rest_cannot_view',
- __( 'Sorry, you are not allowed to view menu locations.' ),
- array( 'status' => rest_authorization_required_code() )
- );
- }
-
- return true;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $this->check_has_read_only_access( $request );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -158,6 +142,32 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks whether the current user has read permission for the endpoint.
+ *
+ * @since 6.8.0
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return true|WP_Error True if the current user has permission, WP_Error object otherwise.
+ */
+ protected function check_has_read_only_access( $request ) {
+ /** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php */
+ $read_only_access = apply_filters( 'rest_menu_read_access', false, $request, $this );
+ if ( $read_only_access ) {
+ return true;
+ }
+
+ if ( ! current_user_can( 'edit_theme_options' ) ) {
+ return new WP_Error(
+ 'rest_cannot_view',
+ __( 'Sorry, you are not allowed to view menu locations.' ),
+ array( 'status' => rest_authorization_required_code() )
+ );
+ }
+
+ return true;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Prepares a menu location object for serialization.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.0
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswprestmenuscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php 2025-01-28 03:48:40 UTC (rev 59717)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php 2025-01-28 04:07:07 UTC (rev 59718)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -84,6 +84,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return true|WP_Error True if the current user has permission, WP_Error object otherwise.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function check_has_read_only_access( $request ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php */
+ $read_only_access = apply_filters( 'rest_menu_read_access', false, $request, $this );
+ if ( $read_only_access ) {
+ return true;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( current_user_can( 'edit_theme_options' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapiwpRestMenuItemsControllerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/wpRestMenuItemsController.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/wpRestMenuItemsController.php 2025-01-28 03:48:40 UTC (rev 59717)
+++ trunk/tests/phpunit/tests/rest-api/wpRestMenuItemsController.php 2025-01-28 04:07:07 UTC (rev 59718)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -184,6 +184,30 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 54304
+ * @covers ::get_items
+ */
+ public function test_get_items_filter() {
+ add_filter( 'rest_menu_read_access', '__return_true' );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/menu-items' );
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->check_get_menu_items_response( $response );
+ }
+
+ /**
+ * @ticket 54304
+ * @covers ::get_item
+ */
+ public function test_get_item_filter() {
+ add_filter( 'rest_menu_read_access', '__return_true' );
+ $request = new WP_REST_Request( 'GET', sprintf( '/wp/v2/menu-items/%d', $this->menu_item_id ) );
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->check_get_menu_item_response( $response, 'view' );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 40878
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::get_item
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapiwpRestMenuLocationsControllerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/wpRestMenuLocationsController.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/wpRestMenuLocationsController.php 2025-01-28 03:48:40 UTC (rev 59717)
+++ trunk/tests/phpunit/tests/rest-api/wpRestMenuLocationsController.php 2025-01-28 04:07:07 UTC (rev 59718)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -121,6 +121,45 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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'] );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 40878
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::get_item
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapiwpRestMenusControllerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/wpRestMenusController.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/wpRestMenusController.php 2025-01-28 03:48:40 UTC (rev 59717)
+++ trunk/tests/phpunit/tests/rest-api/wpRestMenusController.php 2025-01-28 04:07:07 UTC (rev 59718)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -208,7 +208,49 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->check_get_taxonomy_term_response( $response, $nav_menu_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 54304
+ * @covers ::get_items
+ */
+ public function test_get_items_filter() {
+ add_filter( 'rest_menu_read_access', '__return_true' );
+ wp_update_nav_menu_object(
+ 0,
+ array(
+ 'description' => 'Test get',
+ 'menu-name' => 'test Name get',
+ )
+ );
+ $request = new WP_REST_Request( 'GET', '/wp/v2/menus' );
+ $request->set_param( 'per_page', self::$per_page );
+ $response = rest_get_server()->dispatch( $request );
+ $this->check_get_taxonomy_terms_response( $response );
+ }
+
+ /**
+ * @ticket 54304
+ * @covers ::get_item
+ */
+ public function test_get_item_filter() {
+ add_filter( 'rest_menu_read_access', '__return_true' );
+ $nav_menu_id = wp_update_nav_menu_object(
+ 0,
+ array(
+ 'description' => 'Test menu',
+ 'menu-name' => 'test Name',
+ )
+ );
+
+ $this->register_nav_menu_locations( array( 'primary' ) );
+ set_theme_mod( 'nav_menu_locations', array( 'primary' => $nav_menu_id ) );
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/menus/' . $nav_menu_id );
+ $response = rest_get_server()->dispatch( $request );
+ $this->check_get_taxonomy_term_response( $response, $nav_menu_id );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 40878
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::create_item
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre>
</div>
</div>
</body>
</html>