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

Timestamp:

03/22/2019 05:25:38 PM (7 years ago)

Author:

adamsilverstein

Message:

Multisite: add new sites_pre_query and networks_pre_query filters to short circuit WP_Site_Query and WP_Network_Query queries.

Similar to the posts_pre_query filter for WP_Query added in #36687. These filters lets you short circuit the queries to return your own results.

Add a new filter sites_pre_query - which returns null by default. Return a non-null value to bypass WordPress's default get_sites queries.

Developers should note that filtering functions that require pagination information are encouraged to set the found_sites property 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.

Add a new filter networks_pre_query - which returns null by default. Return a non-null value to bypass WordPress's default get_networks queries.

Developers should note that filtering functions that require pagination information are encouraged to set the found_networks property 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.

Props spacedmonkey.
Fixes #45749.

File:

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

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

@@ -910 +910 @@
                 $this->assertEqualSets( $expected, $found );
             }
+        }
+
+
+        /**
+         * @ticket 45749
+         */
+        public function test_sites_pre_query_filter_should_bypass_database_query() {
+            global $wpdb;
+
+            add_filter( 'sites_pre_query', array( __CLASS__, 'filter_sites_pre_query' ), 10, 2 );
+
+            $num_queries = $wpdb->num_queries;
+
+            $q       = new WP_Site_Query();
+            $results = $q->query(
+                array(
+                    'fields' => 'ids',
+                )
+            );
+
+            remove_filter( 'sites_pre_query', array( __CLASS__, 'filter_sites_pre_query' ), 10, 2 );
+
+            // Make sure no queries were executed.
+            $this->assertSame( $num_queries, $wpdb->num_queries );
+
+            // We manually inserted a non-existing site and overrode the results with it.
+            $this->assertSame( array( 555 ), $q->sites );
+
+            // Make sure manually setting total_users doesn't get overwritten.
+            $this->assertEquals( 1, $q->found_sites );
+        }
+
+        public static function filter_sites_pre_query( $sites, $query ) {
+            $query->found_sites = 1;
+
+            return array( 555 );
         }