users_pre_query │ filter-hook │ WP 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' );

/**
 * 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.
 *
 * @return array|null
 */
function wp_kama_users_pre_query_filter( $results ){

	// 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.

Changelog

Where the hook is called

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

Where the hook is used in WordPress