Changeset 49538

Timestamp:

11/08/2020 11:45:36 AM (6 years ago)

Author:

SergeyBiryukov

Message:

Networks and Sites: Assign the array of site or network data returned from filters to the respective class property:

• The array of network data returned from the networks_pre_query filter is assigned to the networks property of the current WP_Network_Query instance.
• The array of site data returned from the sites_pre_query filter is assigned to the sites property of the current WP_Site_Query instance.

This avoids the performance overhead of calling WP_Network_Query::get_networks() or WP_Site_Query::get_sites() twice: first when creating the object instance, then to retrieve the filtered results.

This also makes the filters a bit more consistent with other similar filters, e.g. posts_pre_query, terms_pre_query, comments_pre_query, or users_pre_query.

Follow-up to [46086], [48990].

Props yakimun, spacedmonkey.
Fixes #51333.

Location:

trunk

Files:

• src/wp-includes/class-wp-network-query.php (modified) (2 diffs)
• src/wp-includes/class-wp-site-query.php (modified) (2 diffs)
• tests/phpunit/tests/comment/query.php (modified) (1 diff)
• tests/phpunit/tests/multisite/networkQuery.php (modified) (1 diff)
• tests/phpunit/tests/multisite/siteQuery.php (modified) (1 diff)

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

@@ -213 +213 @@
                  * - Otherwise the filter should return an array of WP_Network objects.
                  *
+                 * Note that if the filter returns an array of network data, it will be assigned
+                 * to the `networks` property of the current WP_Network_Query instance.
+                 *
+                 * Filtering functions that require pagination information are encouraged to set
+                 * the `found_networks` and `max_num_pages` properties of the WP_Network_Query object,
+                 * passed to the filter by reference. If WP_Network_Query does not perform a database
+                 * query, it will not have enough information to generate these values itself.
+                 *
                  * @since 5.2.0
+                 * @since 5.6.0 The returned array of network data is assigned to the `networks` property
+                 *              of the current WP_Network_Query instance.
                  *
                  * @param array|int|null   $network_data Return an array of network data to short-circuit WP's network query,
@@ -223 +233 @@
 
                 if ( null !== $network_data ) {
+                        if ( is_array( $network_data ) && ! $this->query_vars['count'] ) {
+                                $this->networks = $network_data;
+                        }
+
                         return $network_data;
                 }

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

@@ -304 +304 @@
                  * - Otherwise the filter should return an array of WP_Site objects.
                  *
+                 * Note that if the filter returns an array of site data, it will be assigned
+                 * to the `sites` property of the current WP_Site_Query instance.
+                 *
+                 * Filtering functions that require pagination information are encouraged to set
+                 * the `found_sites` and `max_num_pages` properties of the WP_Site_Query object,
+                 * passed to the filter by reference. If WP_Site_Query does not perform a database
+                 * query, it will not have enough information to generate these values itself.
+                 *
                  * @since 5.2.0
+                 * @since 5.6.0 The returned array of site data is assigned to the `sites` property
+                 *              of the current WP_Site_Query instance.
                  *
                  * @param array|int|null $site_data Return an array of site data to short-circuit WP's site query,
@@ -314 +324 @@
 
                 if ( null !== $site_data ) {
+                        if ( is_array( $site_data ) && ! $this->query_vars['count'] ) {
+                                $this->sites = $site_data;
+                        }
+
                         return $site_data;
                 }

trunk/tests/phpunit/tests/comment/query.php

@@ -4927 +4927 @@
                 $results = $q->query( array() );
 
-                remove_filter( 'comments_pre_query', array( __CLASS__, 'filter_comments_pre_query_and_set_comments' ), 10, 2 );
+                remove_filter( 'comments_pre_query', array( __CLASS__, 'filter_comments_pre_query_and_set_comments' ), 10 );
 
                 // Make sure the comments property is the same as the results.

trunk/tests/phpunit/tests/multisite/networkQuery.php

@@ -555 +555 @@
                         return array( 555 );
                 }
+
+                /**
+                 * @ticket 51333
+                 */
+                public function test_networks_pre_query_filter_should_set_networks_property() {
+                        add_filter( 'networks_pre_query', array( __CLASS__, 'filter_networks_pre_query_and_set_networks' ), 10, 2 );
+
+                        $q       = new WP_Network_Query();
+                        $results = $q->query( array() );
+
+                        remove_filter( 'networks_pre_query', array( __CLASS__, 'filter_networks_pre_query_and_set_networks' ), 10 );
+
+                        // Make sure the networks property is the same as the results.
+                        $this->assertSame( $results, $q->networks );
+
+                        // Make sure the network domain is `wordpress.org`.
+                        $this->assertSame( 'wordpress.org', $q->networks[0]->domain );
+                }
+
+                public static function filter_networks_pre_query_and_set_networks( $networks, $query ) {
+                        return array( get_network( self::$network_ids['wordpress.org/'] ) );
+                }
         }
 

trunk/tests/phpunit/tests/multisite/siteQuery.php

@@ -1096 +1096 @@
                         return array( 555 );
                 }
+
+                /**
+                 * @ticket 51333
+                 */
+                public function test_sites_pre_query_filter_should_set_sites_property() {
+                        add_filter( 'sites_pre_query', array( __CLASS__, 'filter_sites_pre_query_and_set_sites' ), 10, 2 );
+
+                        $q       = new WP_Site_Query();
+                        $results = $q->query( array() );
+
+                        remove_filter( 'sites_pre_query', array( __CLASS__, 'filter_sites_pre_query_and_set_sites' ), 10 );
+
+                        // Make sure the sites property is the same as the results.
+                        $this->assertSame( $results, $q->sites );
+
+                        // Make sure the site domain is `wordpress.org`.
+                        $this->assertSame( 'wordpress.org', $q->sites[0]->domain );
+                }
+
+                public static function filter_sites_pre_query_and_set_sites( $sites, $query ) {
+                        return array( get_site( self::$site_ids['wordpress.org/'] ) );
+                }
         }