Filters the users array before the query takes place.

Return a non-null value to bypass WordPress’ 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.

$results array|null

Return an array of user data to short-circuit WP's user query or null to allow WP to run its normal queries.

$query WP_User_Query

The WP_User_Query instance (passed by reference).

File: wp-includes/class-wp-user-query.php. View all references

$this->results = apply_filters_ref_array( 'users_pre_query', array( null, &$this ) );