<!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>[55747] trunk: Networks and Sites: Lazy load site meta.</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/55747">55747</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/55747","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-05-11 11:13:10 +0000 (Thu, 11 May 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'>Networks and Sites: Lazy load site meta.
In <a href="https://core.trac.wordpress.org/changeset/36566">[36566]</a> a framework to lazily load metadata was introduced. This supported term and comment meta by default. In this commit, extends support for site ( blog ) meta. Site meta is not heavily used by core and is used by developers to extend multisite. In this change, `_prime_site_caches` and `WP_Site_Query` now call the new function `wp_lazyload_site_meta`. The function `wp_lazyload_site_meta` accepts an array of ids and adds them to the queue of metadata to be lazily loaded. The function `get_blogs_of_user` was updated to now lazily load site meta.
Follow on from <a href="https://core.trac.wordpress.org/changeset/55671">[55671]</a>.
Props spacedmonkey, johnjamesjacoby, peterwilsoncc, mukesh27.
Fixes <a href="https://core.trac.wordpress.org/ticket/58185">#58185</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="#trunksrcwpincludesclasswpsitequeryphp">trunk/src/wp-includes/class-wp-site-query.php</a></li>
<li><a href="#trunksrcwpincludesmssitephp">trunk/src/wp-includes/ms-site.php</a></li>
<li><a href="#trunksrcwpincludesuserphp">trunk/src/wp-includes/user.php</a></li>
<li><a href="#trunktestsphpunitincludesabstracttestcasephp">trunk/tests/phpunit/includes/abstract-testcase.php</a></li>
<li><a href="#trunktestsphpunittestsmultisitesiteMetaphp">trunk/tests/phpunit/tests/multisite/siteMeta.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-05-11 10:31:29 UTC (rev 55746)
+++ trunk/src/wp-includes/class-wp-metadata-lazyloader.php 2023-05-11 11:13:10 UTC (rev 55747)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -61,6 +61,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'filter' => 'get_comment_metadata',
</span><span class="cx" style="display: block; padding: 0 10px"> 'callback' => array( $this, 'lazyload_meta_callback' ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'blog' => array(
+ 'filter' => 'get_blog_metadata',
+ '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></pre></div>
<a id="trunksrcwpincludesclasswpsitequeryphp"></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-site-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-site-query.php 2023-05-11 10:31:29 UTC (rev 55746)
+++ trunk/src/wp-includes/class-wp-site-query.php 2023-05-11 11:13:10 UTC (rev 55747)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -388,6 +388,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $site_ids = array_map( 'intval', $site_ids );
</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 ( $this->query_vars['update_site_meta_cache'] ) {
+ wp_lazyload_site_meta( $site_ids );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'ids' === $this->query_vars['fields'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->sites = $site_ids;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -396,7 +400,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Prime site network caches.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $this->query_vars['update_site_cache'] ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- _prime_site_caches( $site_ids, $this->query_vars['update_site_meta_cache'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ _prime_site_caches( $site_ids, false );
</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"> // Fetch full site objects from the primed cache.
</span></span></pre></div>
<a id="trunksrcwpincludesmssitephp"></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/ms-site.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/ms-site.php 2023-05-11 10:31:29 UTC (rev 55746)
+++ trunk/src/wp-includes/ms-site.php 2023-05-11 11:13:10 UTC (rev 55747)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -340,6 +340,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.1.0 Introduced the `$update_meta_cache` parameter.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.1.0 This function is no longer marked as "private".
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.3.0 Use wp_lazyload_site_meta() for lazy-loading of site meta.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see update_site_cache()
</span><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database abstraction object.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -354,11 +355,30 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $non_cached_ids ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $fresh_sites = $wpdb->get_results( sprintf( "SELECT * FROM $wpdb->blogs WHERE blog_id IN (%s)", implode( ',', array_map( 'intval', $non_cached_ids ) ) ) ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- update_site_cache( $fresh_sites, $update_meta_cache );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ update_site_cache( $fresh_sites, false );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( $update_meta_cache ) {
+ wp_lazyload_site_meta( $ids );
+ }
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Queue site meta for lazy-loading.
+ *
+ * @since 6.3.0
+ *
+ * @param array $site_ids List of site IDs.
+ */
+function wp_lazyload_site_meta( array $site_ids ) {
+ if ( empty( $site_ids ) ) {
+ return;
+ }
+ $lazyloader = wp_metadata_lazyloader();
+ $lazyloader->queue_objects( 'blog', $site_ids );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Updates sites in cache.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.6.0
</span></span></pre></div>
<a id="trunksrcwpincludesuserphp"></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/user.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/user.php 2023-05-11 10:31:29 UTC (rev 55746)
+++ trunk/src/wp-includes/user.php 2023-05-11 11:13:10 UTC (rev 55747)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1004,9 +1004,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $site_ids ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $args = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'number' => '',
- 'site__in' => $site_ids,
- 'update_site_meta_cache' => false,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'number' => '',
+ 'site__in' => $site_ids,
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $all ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $args['archived'] = 0;
</span></span></pre></div>
<a id="trunktestsphpunitincludesabstracttestcasephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/abstract-testcase.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/abstract-testcase.php 2023-05-11 10:31:29 UTC (rev 55746)
+++ trunk/tests/phpunit/includes/abstract-testcase.php 2023-05-11 11:13:10 UTC (rev 55747)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -281,6 +281,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $lazyloader = wp_metadata_lazyloader();
</span><span class="cx" style="display: block; padding: 0 10px"> $lazyloader->reset_queue( 'term' );
</span><span class="cx" style="display: block; padding: 0 10px"> $lazyloader->reset_queue( 'comment' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $lazyloader->reset_queue( 'blog' );
</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></pre></div>
<a id="trunktestsphpunittestsmultisitesiteMetaphp"></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/multisite/siteMeta.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/multisite/siteMeta.php 2023-05-11 10:31:29 UTC (rev 55746)
+++ trunk/tests/phpunit/tests/multisite/siteMeta.php 2023-05-11 11:13:10 UTC (rev 55747)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -248,9 +248,81 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $num_queries = get_num_queries();
</span><span class="cx" style="display: block; padding: 0 10px"> get_site_meta( self::$site_id, 'foo', true );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( $num_queries, get_num_queries() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( 1, get_num_queries() - $num_queries );
</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">+ /**
+ * @ticket 58185
+ */
+ public function test_lazy_load_site_meta() {
+ if ( ! is_site_meta_supported() ) {
+ $this->markTestSkipped( 'Test only runs with the blogmeta database table installed.' );
+ }
+
+ $filter = new MockAction();
+ add_filter( 'update_blog_metadata_cache', array( $filter, 'filter' ), 10, 2 );
+
+ $q = new WP_Site_Query(
+ array(
+ 'ID' => self::$site_id,
+ )
+ );
+
+ $this->assertSameSets( array( (string) self::$site_id ), wp_list_pluck( $q->sites, 'blog_id' ), 'Site query should return the first test site' );
+
+ $q = new WP_Site_Query(
+ array(
+ 'ID' => self::$site_id2,
+ )
+ );
+
+ $this->assertSameSets( array( (string) self::$site_id2 ), wp_list_pluck( $q->sites, 'blog_id' ), 'Site query should return the second test site' );
+
+ get_site_meta( self::$site_id2 );
+
+ $args = $filter->get_args();
+ $first = reset( $args );
+ $site_ids = end( $first );
+ $this->assertSameSets( $site_ids, array( self::$site_id, self::$site_id2 ), 'This should have two site\'s meta' );
+ }
+
+ /**
+ * @ticket 58185
+ */
+ public function test_lazy_load_site_meta_fields_id() {
+ if ( ! is_site_meta_supported() ) {
+ $this->markTestSkipped( 'Test only runs with the blogmeta database table installed.' );
+ }
+
+ $filter = new MockAction();
+ add_filter( 'update_blog_metadata_cache', array( $filter, 'filter' ), 10, 2 );
+
+ $q = new WP_Site_Query(
+ array(
+ 'ID' => self::$site_id,
+ 'fields' => 'ids',
+ )
+ );
+
+ $this->assertSameSets( array( self::$site_id ), $q->sites, 'Site query should return the first test site' );
+
+ $q = new WP_Site_Query(
+ array(
+ 'ID' => self::$site_id2,
+ 'fields' => 'ids',
+ )
+ );
+
+ $this->assertSameSets( array( self::$site_id2 ), $q->sites, 'Site query should return the second test site' );
+
+ get_site_meta( self::$site_id2 );
+
+ $args = $filter->get_args();
+ $first = reset( $args );
+ $site_ids = end( $first );
+ $this->assertSameSets( $site_ids, array( self::$site_id, self::$site_id2 ), 'This should have two sites meta' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_query_update_site_meta_cache_false() {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_site_meta_supported() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->markTestSkipped( 'Test only runs with the blogmeta database table installed.' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -267,7 +339,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $num_queries = get_num_queries();
</span><span class="cx" style="display: block; padding: 0 10px"> get_site_meta( self::$site_id, 'foo', true );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( $num_queries + 1, get_num_queries() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( 1, get_num_queries() - $num_queries );
</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></pre>
</div>
</div>
</body>
</html>