users_pre_query filter-hookWP 5.1.0

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.

Usage

add_filter( 'users_pre_query', 'wp_kama_users_pre_query_filter', 10, 2 );

/**
 * Function for `users_pre_query` filter-hook.
 * 
 * @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 $query   The WP_User_Query instance (passed by reference).
 *
 * @return array|null
 */
function wp_kama_users_pre_query_filter( $results, $query ){

	// filter...
	return $results;
}
$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).

Changelog

Since 5.1.0 Introduced.

Where the hook is called

WP_User_Query::query()
users_pre_query
wp-includes/class-wp-user-query.php 800
$this->results = apply_filters_ref_array( 'users_pre_query', array( null, &$this ) );

Where the hook is used in WordPress

Usage not found.