Changeset 44373 for trunk/tests/phpunit/tests/user/query.php

Timestamp:

12/29/2018 04:05:50 PM (6 years ago)

Author:

adamsilverstein

Message:

Users: Add a users_pre_query filter to short circuit WP_User_Query results.

Add a new filter users_pre_query - filters the users array before the query takes place. Return a non-null value to bypass WordPress's default user queries. Similar to the posts_pre_query filter for WP_Query added in #36687. This filter lets you short circuit the WP_User_Query MySQL query to return your own results.

Developers should note that filtering functions that require pagination information are encouraged to set the total_users property of the WP_User_Query object, passed to the filter by reference. If WP_User_Query does not perform a database query, it will not have enough information to generate these values itself.

Props tlovett1, birgire, boonebgorges, spacedmonkey.
Fixes #44169.

File:

• trunk/tests/phpunit/tests/user/query.php (modified) (1 diff)

trunk/tests/phpunit/tests/user/query.php

@@ -1691 +1691 @@
         $this->assertEquals( array(), $ids );
     }
+
+    /**
+     * @ticket 44169
+     */
+    public function test_users_pre_query_filter_should_bypass_database_query() {
+        global $wpdb;
+
+        add_filter( 'users_pre_query', array( __CLASS__, 'filter_users_pre_query' ), 10, 2 );
+
+        $num_queries = $wpdb->num_queries;
+        $q           = new WP_User_Query(
+            array(
+                'fields' => 'ID',
+            )
+        );
+
+        remove_filter( 'users_pre_query', array( __CLASS__, 'filter_users_pre_query' ), 10, 2 );
+
+        // Make sure no queries were executed.
+        $this->assertSame( $num_queries, $wpdb->num_queries );
+
+        // We manually inserted a non-existing user and overrode the results with it.
+        $this->assertSame( array( 555 ), $q->results );
+
+        // Make sure manually setting total_users doesn't get overwritten.
+        $this->assertEquals( 1, $q->total_users );
+    }
+
+    public static function filter_users_pre_query( $posts, $query ) {
+        $query->total_users = 1;
+
+        return array( 555 );
+    }
 }