Changeset 49538 for trunk/tests/phpunit/tests/multisite/siteQuery.php

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.

File:

• trunk/tests/phpunit/tests/multisite/siteQuery.php (modified) (1 diff)

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/'] ) );
+                }
         }