users_pre_query WordPress Filter Hook
The users_pre_query hook is triggered before a user query is run. It allows you to modify the user query arguments before the query is run. This can be useful for customizing the user query results.
apply_filters_ref_array( 'users_pre_query', array|null $results , WP_User_Query $query ) #
Filters the users array before the query takes place.
Description
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.
Parameters
- $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).
Source
Changelog
| Version | Description |
|---|---|
| 5.1.0 | Introduced. |