<!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>[46100] trunk: Multisite: improve `sites_pre_query` and `networks_pre_query` filters, avoiding db queries.</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/46100">46100</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/46100","name":"Review Commit"}}</script></dd>

<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>adamsilverstein</dd>

<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-09-12 22:16:08 +0000 (Thu, 12 Sep 2019)</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'>Multisite: improve `sites_pre_query` and `networks_pre_query` filters, avoiding db queries.

Improve the `pre_query` filters in multisite classes introduced in <a href="https://core.trac.wordpress.org/changeset/44983">r44983</a>. Return (non null) values immediately,

avoiding the database queries entirely, similar to other `pre_query` filters.

Props spacedmonkey, SergeyBiryukov, felipeelia.

Fixes <a href="https://core.trac.wordpress.org/ticket/47599">#47599</a>.</pre>

<h3>Modified Paths</h3>

<ul>

<li><a href="#trunksrcwpincludesclasswpnetworkqueryphp">trunk/src/wp-includes/class-wp-network-query.php</a></li>

<li><a href="#trunksrcwpincludesclasswpsitequeryphp">trunk/src/wp-includes/class-wp-site-query.php</a></li>

<li><a href="#trunktestsphpunittestsmultisitenetworkQueryphp">trunk/tests/phpunit/tests/multisite/networkQuery.php</a></li>

<li><a href="#trunktestsphpunittestsmultisitesiteQueryphp">trunk/tests/phpunit/tests/multisite/siteQuery.php</a></li>

</ul>

</div>

<div id="patch">

<h3>Diff</h3>

<a id="trunksrcwpincludesclasswpnetworkqueryphp"></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-network-query.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-network-query.php  2019-09-12 21:46:41 UTC (rev 46099)

+++ trunk/src/wp-includes/class-wp-network-query.php    2019-09-12 22:16:08 UTC (rev 46100)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -197,50 +197,57 @@

</span><span class="cx" style="display: block; padding: 0 10px">                 */

</span><span class="cx" style="display: block; padding: 0 10px">                do_action_ref_array( 'pre_get_networks', array( &$this ) );

</span><span class="cx" style="display: block; padding: 0 10px"> 

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                $network_ids = null;

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         $network_data = null;

</ins><span class="cx" style="display: block; padding: 0 10px"> 

</span><span class="cx" style="display: block; padding: 0 10px">                /**

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                 * Filter the sites array before the query takes place.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+          * Filter the network data before the query takes place.

</ins><span class="cx" style="display: block; padding: 0 10px">                  *

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                 * Return a non-null value to bypass WordPress's default site queries.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+          * Return a non-null value to bypass WordPress's default network queries.

</ins><span class="cx" style="display: block; padding: 0 10px">                  *

<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                 * The expected return type from this filter depends on the value passed in the request query_vars.

+                * When `$this->query_vars['count']` is set, the filter should return the network count as an int.

+                * When `'ids' === $this->query_vars['fields']`, the filter should return an array of network ids.

+                * Otherwise the filter should return an array of WP_Network objects.

+                *

</ins><span class="cx" style="display: block; padding: 0 10px">                  * @since 5.2.0

</span><span class="cx" style="display: block; padding: 0 10px">                 *

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                 * @param array|null       $site_ids Return an array of site data to short-circuit WP's site query,

-                *                                   or null to allow WP to run its normal queries.

-                * @param WP_Network_Query $this     The WP_Network_Query instance, passed by reference.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+          * @param array|null       $network_data Return an array of network data to short-circuit WP's network query,

+                *                                       the network count as an integer if `$this->query_vars['count']` is set,

+                *                                       or null to allow WP to run its normal queries.

+                * @param WP_Network_Query $this         The WP_Network_Query instance, passed by reference.

</ins><span class="cx" style="display: block; padding: 0 10px">                  */

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                $network_ids = apply_filters_ref_array( 'networks_pre_query', array( $network_ids, &$this ) );

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         $network_data = apply_filters_ref_array( 'networks_pre_query', array( $network_data, &$this ) );

</ins><span class="cx" style="display: block; padding: 0 10px"> 

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                if ( null === $network_ids ) {

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         if ( null !== $network_data ) {

+                       return $network_data;

+               }

</ins><span class="cx" style="display: block; padding: 0 10px"> 

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                        // $args can include anything. Only use the args defined in the query_var_defaults to compute the key.

-                       $_args = wp_array_slice_assoc( $this->query_vars, array_keys( $this->query_var_defaults ) );

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         // $args can include anything. Only use the args defined in the query_var_defaults to compute the key.

+               $_args = wp_array_slice_assoc( $this->query_vars, array_keys( $this->query_var_defaults ) );

</ins><span class="cx" style="display: block; padding: 0 10px"> 

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                        // Ignore the $fields argument as the queried result will be the same regardless.

-                       unset( $_args['fields'] );

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         // Ignore the $fields argument as the queried result will be the same regardless.

+               unset( $_args['fields'] );

</ins><span class="cx" style="display: block; padding: 0 10px"> 

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                        $key          = md5( serialize( $_args ) );

-                       $last_changed = wp_cache_get_last_changed( 'networks' );

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         $key          = md5( serialize( $_args ) );

+               $last_changed = wp_cache_get_last_changed( 'networks' );

</ins><span class="cx" style="display: block; padding: 0 10px"> 

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                        $cache_key   = "get_network_ids:$key:$last_changed";

-                       $cache_value = wp_cache_get( $cache_key, 'networks' );

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         $cache_key   = "get_network_ids:$key:$last_changed";

+               $cache_value = wp_cache_get( $cache_key, 'networks' );

</ins><span class="cx" style="display: block; padding: 0 10px"> 

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                        if ( false === $cache_value ) {

-                               $network_ids = $this->get_network_ids();

-                               if ( $network_ids ) {

-                                       $this->set_found_networks();

-                               }

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         if ( false === $cache_value ) {

+                       $network_ids = $this->get_network_ids();

+                       if ( $network_ids ) {

+                               $this->set_found_networks();

+                       }

</ins><span class="cx" style="display: block; padding: 0 10px"> 

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                                $cache_value = array(

-                                       'network_ids'    => $network_ids,

-                                       'found_networks' => $this->found_networks,

-                               );

-                               wp_cache_add( $cache_key, $cache_value, 'networks' );

-                       } else {

-                               $network_ids          = $cache_value['network_ids'];

-                               $this->found_networks = $cache_value['found_networks'];

-                       }

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                 $cache_value = array(

+                               'network_ids'    => $network_ids,

+                               'found_networks' => $this->found_networks,

+                       );

+                       wp_cache_add( $cache_key, $cache_value, 'networks' );

+               } else {

+                       $network_ids          = $cache_value['network_ids'];

+                       $this->found_networks = $cache_value['found_networks'];

</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">                if ( $this->found_networks && $this->query_vars['number'] ) {

</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     2019-09-12 21:46:41 UTC (rev 46099)

+++ trunk/src/wp-includes/class-wp-site-query.php       2019-09-12 22:16:08 UTC (rev 46100)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -288,50 +288,57 @@

</span><span class="cx" style="display: block; padding: 0 10px">                        $this->meta_query_clauses = $this->meta_query->get_sql( 'blog', $wpdb->blogs, 'blog_id', $this );

</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">-                $site_ids = null;

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         $site_data = null;

</ins><span class="cx" style="display: block; padding: 0 10px"> 

</span><span class="cx" style="display: block; padding: 0 10px">                /**

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                 * Filter the sites array before the query takes place.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+          * Filter the site data before the get_sites query takes place.

</ins><span class="cx" style="display: block; padding: 0 10px">                  *

<span class="cx" style="display: block; padding: 0 10px">                 * Return a non-null value to bypass WordPress's default site queries.

</span><span class="cx" style="display: block; padding: 0 10px">                 *

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                 * The expected return type from this filter depends on the value passed in the request query_vars:

+                * When `$this->query_vars['count']` is set, the filter should return the site count as an int.

+                * When `'ids' == $this->query_vars['fields']`, the filter should return an array of site ids.

+                * Otherwise the filter should return an array of WP_Site objects.

+                *

</ins><span class="cx" style="display: block; padding: 0 10px">                  * @since 5.2.0

</span><span class="cx" style="display: block; padding: 0 10px">                 *

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                 * @param array|null    $site_ids Return an array of site data to short-circuit WP's site query,

-                *                                or null to allow WP to run its normal queries.

-                * @param WP_Site_Query $this The WP_Site_Query instance, passed by reference.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+          * @param array|int|null $site_data Return an array of site data to short-circuit WP's site query,

+                *                                  the site count as an integer if `$this->query_vars['count']` is set,

+                *                                  or null to run the normal queries.

+                * @param WP_Site_Query  $this      The WP_Site_Query instance, passed by reference.

</ins><span class="cx" style="display: block; padding: 0 10px">                  */

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                $site_ids = apply_filters_ref_array( 'sites_pre_query', array( $site_ids, &$this ) );

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         $site_data = apply_filters_ref_array( 'sites_pre_query', array( $site_data, &$this ) );

</ins><span class="cx" style="display: block; padding: 0 10px"> 

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                if ( null === $site_ids ) {

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         if ( null !== $site_data ) {

+                       return $site_data;

+               }

</ins><span class="cx" style="display: block; padding: 0 10px"> 