sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

Browse Source 
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.


git-svn-id: https://develop.svn.wordpress.org/trunk@44373 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Adam Silverstein 2018-12-29 16:05:50 +00:00
parent 2b8eced416
commit 4589c03036
2 changed files with 71 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
src/wp-includes/class-wp-user-query.php
View File

@ -592,29 +592,47 @@ class WP_User_Query {
$qv =& $this->query_vars; $qv =& $this->query_vars;
$this->request = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit"; /**
* Filters the users array before the query takes place.
*
* Return a non-null value to bypass WordPress's default user queries.
* 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.
*
* @since 5.0.3
*
* @param array|null $results Return an array of user data to short-circuit WP's user query or null to allow WP to run its normal queries.
* @param WP_User_Query $this The WP_User_Query instance (passed by reference).
*/
$this->results = apply_filters_ref_array( 'users_pre_query', array( null, &$this ) );
if ( is_array( $qv['fields'] ) || 'all' == $qv['fields'] ) { if ( null === $this->results ) {
$this->results = $wpdb->get_results( $this->request ); $this->request = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit";
} else {
$this->results = $wpdb->get_col( $this->request );
}
if ( isset( $qv['count_total'] ) && $qv['count_total'] ) { if ( is_array( $qv['fields'] ) || 'all' == $qv['fields'] ) {
/** $this->results = $wpdb->get_results( $this->request );
* Filters SELECT FOUND_ROWS() query for the current WP_User_Query instance. } else {
* $this->results = $wpdb->get_col( $this->request );
* @since 3.2.0 }
* @since 5.1.0 Added the `$this` parameter.
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $sql The SELECT FOUND_ROWS() query for the current WP_User_Query.
* @param WP_User_Query $this The current WP_User_Query instance.
*/
$found_users_query = apply_filters( 'found_users_query', 'SELECT FOUND_ROWS()', $this );
$this->total_users = (int) $wpdb->get_var( $found_users_query ); if ( isset( $qv['count_total'] ) && $qv['count_total'] ) {
/**
* Filters SELECT FOUND_ROWS() query for the current WP_User_Query instance.
*
* @since 3.2.0
* @since 5.0.3 Added the `$this` parameter.
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $sql The SELECT FOUND_ROWS() query for the current WP_User_Query.
* @param WP_User_Query $this The current WP_User_Query instance.
*/
$found_users_query = apply_filters( 'found_users_query', 'SELECT FOUND_ROWS()', $this );
$this->total_users = (int) $wpdb->get_var( $found_users_query );
}
} }
if ( ! $this->results ) { if ( ! $this->results ) {

33
tests/phpunit/tests/user/query.php
View File

@ -1690,4 +1690,37 @@ class Tests_User_Query extends WP_UnitTestCase {
/* must not include user that has same string in other fields */ /* must not include user that has same string in other fields */
$this->assertEquals( array(), $ids ); $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 );
}
} }