Changeset 46100 for trunk/src/wp-includes/class-wp-site-query.php

Timestamp:

09/12/2019 10:16:08 PM (7 years ago)

Author:

adamsilverstein

Message:

Multisite: improve sites_pre_query and networks_pre_query filters, avoiding db queries.

Improve the pre_query filters in multisite classes introduced in r44983. Return (non null) values immediately,
avoiding the database queries entirely, similar to other pre_query filters.

Props spacedmonkey, SergeyBiryukov, felipeelia.
Fixes #47599.

File:

• trunk/src/wp-includes/class-wp-site-query.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-site-query.php

@@ -289 +289 @@
                 }
 
-                $site_ids = null;
+                $site_data = null;
 
                 /**
-                 * Filter the sites array before the query takes place.
+                 * Filter the site data before the get_sites query takes place.
                  *
                  * Return a non-null value to bypass WordPress's default site queries.
                  *
+                 * 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.
+                 *
                  * @since 5.2.0
                  *
-                 * @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.
+                 * @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.
                  */
-                $site_ids = apply_filters_ref_array( 'sites_pre_query', array( $site_ids, &$this ) );
-
-                if ( null === $site_ids ) {
-
-                        // $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 ) );
-
-                        // Ignore the $fields argument as the queried result will be the same regardless.
-                        unset( $_args['fields'] );
-
-                        $key          = md5( serialize( $_args ) );
-                        $last_changed = wp_cache_get_last_changed( 'sites' );
-
-                        $cache_key   = "get_sites:$key:$last_changed";
-                        $cache_value = wp_cache_get( $cache_key, 'sites' );
-
-                        if ( false === $cache_value ) {
-                                $site_ids = $this->get_site_ids();
-                                if ( $site_ids ) {
-                                        $this->set_found_sites();
-                                }
-
-                                $cache_value = array(
-                                        'site_ids'    => $site_ids,
-                                        'found_sites' => $this->found_sites,
-                                );
-                                wp_cache_add( $cache_key, $cache_value, 'sites' );
-                        } else {
-                                $site_ids          = $cache_value['site_ids'];
-                                $this->found_sites = $cache_value['found_sites'];
+                $site_data = apply_filters_ref_array( 'sites_pre_query', array( $site_data, &$this ) );
+
+                if ( null !== $site_data ) {
+                        return $site_data;
+                }
+
+                // $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 ) );
+
+                // Ignore the $fields argument as the queried result will be the same regardless.
+                unset( $_args['fields'] );
+
+                $key          = md5( serialize( $_args ) );
+                $last_changed = wp_cache_get_last_changed( 'sites' );
+
+                $cache_key   = "get_sites:$key:$last_changed";
+                $cache_value = wp_cache_get( $cache_key, 'sites' );
+
+                if ( false === $cache_value ) {
+                        $site_ids = $this->get_site_ids();
+                        if ( $site_ids ) {
+                                $this->set_found_sites();
                         }
+
+                        $cache_value = array(
+                                'site_ids'    => $site_ids,
+                                'found_sites' => $this->found_sites,
+                        );
+                        wp_cache_add( $cache_key, $cache_value, 'sites' );
+                } else {
+                        $site_ids          = $cache_value['site_ids'];
+                        $this->found_sites = $cache_value['found_sites'];
                 }