<!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>[55608] trunk: Options, Meta APIs: Improve the lazy loading meta API to include current object id.</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/55608">55608</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/55608","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>2023-03-29 10:48:34 +0000 (Wed, 29 Mar 2023)</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'>Options, Meta APIs: Improve the lazy loading meta API to include current object id.
The existing lazy loading meta api, creates a queue of ids, to be primed, if the `get_comment_meta` or `get_term_meta` functions are called. However, it did not check to see if the requested id was in the queue, before prime all the ids in the queue. Now, it adds the id to the queue, is not already in the queue, saving a cache lookup / database query.
Props spacedmonkey, peterwilsoncc, mukesh27, flixos90.
Fixes <a href="https://core.trac.wordpress.org/ticket/57901">#57901</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpmetadatalazyloaderphp">trunk/src/wp-includes/class-wp-metadata-lazyloader.php</a></li>
<li><a href="#trunktestsphpunittestsquerylazyLoadTermMetaphp">trunk/tests/phpunit/tests/query/lazyLoadTermMeta.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsquerylazyLoadCommentMetaphp">trunk/tests/phpunit/tests/query/lazyLoadCommentMeta.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpmetadatalazyloaderphp"></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-metadata-lazyloader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-metadata-lazyloader.php 2023-03-29 10:18:34 UTC (rev 55607)
+++ trunk/src/wp-includes/class-wp-metadata-lazyloader.php 2023-03-29 10:48:34 UTC (rev 55608)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -55,11 +55,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->settings = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'term' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'filter' => 'get_term_metadata',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'callback' => array( $this, 'lazyload_term_meta' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'callback' => array( $this, 'lazyload_meta_callback' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'comment' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'filter' => 'get_comment_metadata',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'callback' => array( $this, 'lazyload_comment_meta' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'callback' => array( $this, 'lazyload_meta_callback' ),
</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">@@ -91,7 +91,7 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_filter( $type_settings['filter'], $type_settings['callback'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_filter( $type_settings['filter'], $type_settings['callback'], 10, 5 );
</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"> * Fires after objects are added to the metadata lazy-load queue.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -131,6 +131,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * is no need to invoke it directly.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.5.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @deprecated 6.3.0 Use WP_Metadata_Lazyloader::lazyload_meta_callback() instead.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $check The `$check` param passed from the 'get_term_metadata' hook.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return mixed In order not to short-circuit `get_metadata()`. Generally, this is `null`, but it could be
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -137,14 +138,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * another value if filtered by a plugin.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function lazyload_term_meta( $check ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! empty( $this->pending_objects['term'] ) ) {
- update_termmeta_cache( array_keys( $this->pending_objects['term'] ) );
-
- // No need to run again for this set of terms.
- $this->reset_queue( 'term' );
- }
-
- return $check;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ _deprecated_function( __METHOD__, '6.3.0', 'WP_Metadata_Lazyloader::lazyload_meta_callback' );
+ return $this->lazyload_meta_callback( $check, 0, '', false, 'term' );
</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">@@ -154,18 +149,48 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * directly, from either inside or outside the `WP_Query` object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.5.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @deprecated 6.3.0 Use WP_Metadata_Lazyloader::lazyload_meta_callback() instead.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $check The `$check` param passed from the {@see 'get_comment_metadata'} hook.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return mixed The original value of `$check`, so as not to short-circuit `get_comment_metadata()`.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function lazyload_comment_meta( $check ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! empty( $this->pending_objects['comment'] ) ) {
- update_meta_cache( 'comment', array_keys( $this->pending_objects['comment'] ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ _deprecated_function( __METHOD__, '6.3.0', 'WP_Metadata_Lazyloader::lazyload_meta_callback' );
+ return $this->lazyload_meta_callback( $check, 0, '', false, 'comment' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // No need to run again for this set of comments.
- $this->reset_queue( 'comment' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Lazy-loads meta for queued objects.
+ *
+ * This method is public so that it can be used as a filter callback. As a rule, there
+ * is no need to invoke it directly.
+ *
+ * @since 6.3.0
+ *
+ * @param mixed $check The `$check` param passed from the 'get_*_metadata' hook.
+ * @param int $object_id ID of the object metadata is for.
+ * @param string $meta_key Unused.
+ * @param bool $single Unused.
+ * @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user',
+ * or any other object type with an associated meta table.
+ * @return mixed In order not to short-circuit `get_metadata()`. Generally, this is `null`, but it could be
+ * another value if filtered by a plugin.
+ */
+ public function lazyload_meta_callback( $check, $object_id, $meta_key, $single, $meta_type ) {
+ if ( empty( $this->pending_objects[ $meta_type ] ) ) {
+ return $check;
</ins><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">+ $object_ids = array_keys( $this->pending_objects[ $meta_type ] );
+ if ( $object_id && ! in_array( $object_id, $object_ids, true ) ) {
+ $object_ids[] = $object_id;
+ }
+
+ update_meta_cache( $meta_type, $object_ids );
+
+ // No need to run again for this set of objects.
+ $this->reset_queue( $meta_type );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $check;
</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="trunktestsphpunittestsquerylazyLoadCommentMetaphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/query/lazyLoadCommentMeta.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/query/lazyLoadCommentMeta.php (rev 0)
+++ trunk/tests/phpunit/tests/query/lazyLoadCommentMeta.php 2023-03-29 10:48:34 UTC (rev 55608)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,66 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group comments
+ * @group meta
+ */
+class Tests_Lazy_Load_Comment_Meta extends WP_UnitTestCase {
+
+ /**
+ * @var int
+ */
+ protected static $post_id;
+
+ /**
+ * @var array
+ */
+ protected static $comment_ids = array();
+
+ public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
+
+ self::$post_id = $factory->post->create();
+ self::$comment_ids = $factory->comment->create_post_comments( self::$post_id, 11 );
+ }
+
+ /**
+ * @ticket 57901
+ *
+ * @covers ::wp_queue_comments_for_comment_meta_lazyload
+ */
+ public function test_wp_queue_comments_for_comment_meta_lazyload() {
+ $filter = new MockAction();
+ add_filter( 'update_comment_metadata_cache', array( $filter, 'filter' ), 10, 2 );
+ $comments = array_map( 'get_comment', self::$comment_ids );
+ $comment_id = reset( self::$comment_ids );
+ wp_queue_comments_for_comment_meta_lazyload( $comments );
+ get_comment_meta( $comment_id );
+
+ $args = $filter->get_args();
+ $first = reset( $args );
+ $comment_meta_ids = end( $first );
+ $this->assertSameSets( self::$comment_ids, $comment_meta_ids );
+ }
+
+ /**
+ * @ticket 57901
+ *
+ * @covers ::wp_queue_comments_for_comment_meta_lazyload
+ */
+ public function test_wp_queue_comments_for_comment_meta_lazyload_new_comment() {
+ $filter = new MockAction();
+ add_filter( 'update_comment_metadata_cache', array( $filter, 'filter' ), 10, 2 );
+ $comments = array_map( 'get_comment', self::$comment_ids );
+ $comment_id = self::factory()->comment->create(
+ array(
+ 'comment_post_ID' => self::$post_id,
+ )
+ );
+ wp_queue_comments_for_comment_meta_lazyload( $comments );
+ get_comment_meta( $comment_id );
+
+ $args = $filter->get_args();
+ $first = reset( $args );
+ $comment_meta_ids = end( $first );
+ $this->assertContains( $comment_id, $comment_meta_ids );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/query/lazyLoadCommentMeta.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunktestsphpunittestsquerylazyLoadTermMetaphp"></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/query/lazyLoadTermMeta.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/query/lazyLoadTermMeta.php 2023-03-29 10:18:34 UTC (rev 55607)
+++ trunk/tests/phpunit/tests/query/lazyLoadTermMeta.php 2023-03-29 10:48:34 UTC (rev 55608)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -108,7 +108,37 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSameSets( $term_ids, array( $term_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 57901
+ *
+ * @covers ::wp_queue_posts_for_term_meta_lazyload
+ */
+ public function test_wp_queue_posts_for_term_meta_lazyload_insert_term() {
+ $filter = new MockAction();
+ add_filter( 'update_term_metadata_cache', array( $filter, 'filter' ), 10, 2 );
+
+ register_taxonomy( 'wptests_tax', 'post' );
+
+ $t1 = wp_insert_term( 'Foo', 'wptests_tax' );
+ $term_id = $t1['term_id'];
+
+ new WP_Query(
+ array(
+ 'post__in' => self::$post_ids,
+ 'lazy_load_term_meta' => true,
+ )
+ );
+
+ get_term_meta( $term_id );
+
+ $args = $filter->get_args();
+ $first = reset( $args );
+ $term_ids = end( $first );
+ $this->assertContains( $term_id, $term_ids );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 57150
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::wp_queue_posts_for_term_meta_lazyload
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -133,6 +163,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $args = $filter->get_args();
</span><span class="cx" style="display: block; padding: 0 10px"> $first = reset( $args );
</span><span class="cx" style="display: block; padding: 0 10px"> $term_ids = end( $first );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertNotContains( $remove_term_id, $term_ids );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertContains( $remove_term_id, $term_ids );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>