<!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>[53504] trunk: REST API: Prime caches for linked objects in menu item REST API controller.</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/53504">53504</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/53504","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>2022-06-15 10:18:02 +0000 (Wed, 15 Jun 2022)</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: Prime caches for linked objects in menu item REST API controller.
Add a new parameter to `WP_Query` called `update_menu_item_cache` that when set to true, primes the caches for linked terms and posts for menu item post objects. This change moves logic
found in `wp_get_nav_menu_items` into a new function called `update_menu_item_cache`. Update the menu item REST API controller, to pass the `update_menu_item_cache` parameter to the
arguments used for the `WP_Query` run to get menu items.
Props furi3r, TimothyBlynJacobs, spacedmonkey, peterwilsoncc, mitogh.
Fixes <a href="https://core.trac.wordpress.org/ticket/55620">#55620</a>.
--This line, and those below, will be ignored--
M src/wp-includes/class-wp-query.php
M src/wp-includes/nav-menu.php
M src/wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php
M tests/phpunit/tests/post/nav-menu.php</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpqueryphp">trunk/src/wp-includes/class-wp-query.php</a></li>
<li><a href="#trunksrcwpincludesnavmenuphp">trunk/src/wp-includes/nav-menu.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestmenuitemscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php</a></li>
<li><a href="#trunktestsphpunittestspostnavmenuphp">trunk/tests/phpunit/tests/post/nav-menu.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpqueryphp"></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/class-wp-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-query.php 2022-06-14 16:15:52 UTC (rev 53503)
+++ trunk/src/wp-includes/class-wp-query.php 2022-06-15 10:18:02 UTC (rev 53504)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -756,6 +756,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $title Post title.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $update_post_meta_cache Whether to update the post meta cache. Default true.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $update_post_term_cache Whether to update the post term cache. Default true.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type bool $update_menu_item_cache Whether to update the menu item cache. Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type bool $lazy_load_term_meta Whether to lazy-load term meta. Setting to false will
</span><span class="cx" style="display: block; padding: 0 10px"> * disable cache priming for term meta, so that each
</span><span class="cx" style="display: block; padding: 0 10px"> * get_term_meta() call will hit the database.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1871,6 +1872,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $q['update_post_term_cache'] = true;
</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">+ if ( ! isset( $q['update_menu_item_cache'] ) ) {
+ $q['update_menu_item_cache'] = false;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $q['lazy_load_term_meta'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $q['lazy_load_term_meta'] = $q['update_post_term_cache'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3147,6 +3152,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->posts = array_map( 'get_post', $this->posts );
</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">+ if ( ! empty( $this->posts ) && $q['update_menu_item_cache'] ) {
+ update_menu_item_cache( $this->posts );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! $q['suppress_filters'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the raw post results array, prior to status checks.
</span></span></pre></div>
<a id="trunksrcwpincludesnavmenuphp"></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/nav-menu.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/nav-menu.php 2022-06-14 16:15:52 UTC (rev 53503)
+++ trunk/src/wp-includes/nav-menu.php 2022-06-15 10:18:02 UTC (rev 53504)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -691,21 +691,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- static $fetched = array();
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( ! taxonomy_exists( 'nav_menu' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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"> $defaults = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'order' => 'ASC',
- 'orderby' => 'menu_order',
- 'post_type' => 'nav_menu_item',
- 'post_status' => 'publish',
- 'output' => ARRAY_A,
- 'output_key' => 'menu_order',
- 'nopaging' => true,
- 'tax_query' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'order' => 'ASC',
+ 'orderby' => 'menu_order',
+ 'post_type' => 'nav_menu_item',
+ 'post_status' => 'publish',
+ 'output' => ARRAY_A,
+ 'output_key' => 'menu_order',
+ 'nopaging' => true,
+ 'update_menu_item_cache' => true,
+ 'tax_query' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'taxonomy' => 'nav_menu',
</span><span class="cx" style="display: block; padding: 0 10px"> 'field' => 'term_taxonomy_id',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -720,33 +719,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $items = array();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Prime posts and terms caches.
- if ( empty( $fetched[ $menu->term_id ] ) ) {
- $fetched[ $menu->term_id ] = true;
- $post_ids = array();
- $term_ids = array();
- foreach ( $items as $item ) {
- $object_id = get_post_meta( $item->ID, '_menu_item_object_id', true );
- $type = get_post_meta( $item->ID, '_menu_item_type', true );
-
- if ( 'post_type' === $type ) {
- $post_ids[] = (int) $object_id;
- } elseif ( 'taxonomy' === $type ) {
- $term_ids[] = (int) $object_id;
- }
- }
-
- if ( ! empty( $post_ids ) ) {
- _prime_post_caches( $post_ids, false );
- }
- unset( $post_ids );
-
- if ( ! empty( $term_ids ) ) {
- _prime_term_caches( $term_ids );
- }
- unset( $term_ids );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> $items = array_map( 'wp_setup_nav_menu_item', $items );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_admin() ) { // Remove invalid items only on front end.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -781,6 +753,40 @@
</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">+ * Prime all linked objects to menu items.
+ *
+ * @since 6.1.0
+ *
+ * @param WP_Post[] $menu_items Array post objects of menu items.
+ */
+function update_menu_item_cache( $menu_items ) {
+ $post_ids = array();
+ $term_ids = array();
+
+ foreach ( $menu_items as $menu_item ) {
+ if ( 'nav_menu_item' !== $menu_item->post_type ) {
+ continue;
+ }
+ $object_id = get_post_meta( $menu_item->ID, '_menu_item_object_id', true );
+ $type = get_post_meta( $menu_item->ID, '_menu_item_type', true );
+
+ if ( 'post_type' === $type ) {
+ $post_ids[] = (int) $object_id;
+ } elseif ( 'taxonomy' === $type ) {
+ $term_ids[] = (int) $object_id;
+ }
+ }
+
+ if ( ! empty( $post_ids ) ) {
+ _prime_post_caches( $post_ids, false );
+ }
+
+ if ( ! empty( $term_ids ) ) {
+ _prime_term_caches( $term_ids );
+ }
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Decorates a menu item object with the shared navigation menu item properties.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Properties:
</span></span></pre></div>
<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 2022-06-14 16:15:52 UTC (rev 53503)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php 2022-06-15 10:18:02 UTC (rev 53504)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -998,6 +998,8 @@
</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">+ $query_args['update_menu_item_cache'] = true;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $query_args;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestspostnavmenuphp"></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/post/nav-menu.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/post/nav-menu.php 2022-06-14 16:15:52 UTC (rev 53503)
+++ trunk/tests/phpunit/tests/post/nav-menu.php 2022-06-15 10:18:02 UTC (rev 53504)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -203,6 +203,67 @@
</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 55620
+ */
+ public function test_update_menu_item_cache_primed_post() {
+ $post_id = self::factory()->post->create();
+ wp_update_nav_menu_item(
+ $this->menu_id,
+ 0,
+ array(
+ 'menu-item-type' => 'post_type',
+ 'menu-item-object' => 'post',
+ 'menu-item-object-id' => $post_id,
+ 'menu-item-status' => 'publish',
+ )
+ );
+
+ $posts_query = new WP_Query();
+ $query_result = $posts_query->query( array( 'post_type' => 'nav_menu_item' ) );
+
+ wp_cache_delete( $post_id, 'posts' );
+ $action = new MockAction();
+ add_filter( 'update_post_metadata_cache', array( $action, 'filter' ), 10, 2 );
+
+ update_menu_item_cache( $query_result );
+
+ $args = $action->get_args();
+ $last = end( $args );
+ $this->assertEqualSets( array( $post_id ), $last[1], '_prime_post_caches was not executed.' );
+ }
+
+ /**
+ * @ticket 55620
+ */
+ public function test_update_menu_item_cache_primed_terms() {
+ register_taxonomy( 'wptests_tax', 'post', array( 'hierarchical' => true ) );
+ $term_id = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+ wp_update_nav_menu_item(
+ $this->menu_id,
+ 0,
+ array(
+ 'menu-item-type' => 'taxonomy',
+ 'menu-item-object' => 'wptests_tax',
+ 'menu-item-object-id' => $term_id,
+ 'menu-item-status' => 'publish',
+ )
+ );
+
+ $posts_query = new WP_Query();
+ $query_result = $posts_query->query( array( 'post_type' => 'nav_menu_item' ) );
+
+ wp_cache_delete( $term_id, 'terms' );
+ $action = new MockAction();
+ add_filter( 'update_term_metadata_cache', array( $action, 'filter' ), 10, 2 );
+
+ update_menu_item_cache( $query_result );
+
+ $args = $action->get_args();
+ $last = end( $args );
+ $this->assertEqualSets( array( $term_id ), $last[1], '_prime_term_caches was not executed.' );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 13910
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_wp_get_nav_menu_name() {
</span></span></pre>
</div>
</div>
</body>
</html>