users_pre_query — filter WordPress: параметры и применение

Сигнатура

apply_filters_ref_array( 'users_pre_query', array|null $results, WP_User_Query $query )

Описание

Верните значение, отличное от null, чтобы обойти стандартные пользовательские запросы WordPress.
Фильтрующим функциям, которым нужна информация о постраничной навигации, рекомендуется задавать свойство total_users объекта WP_User_Query, передаваемого в фильтр по ссылке. Если WP_User_Query не выполняет запрос к базе данных, у него не будет достаточно информации, чтобы сформировать эти значения самостоятельно.

Оригинал (английский)

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.

Фильтруемое значение

Верните массив данных пользователей, чтобы прервать пользовательский запрос WP, или null, чтобы позволить WP выполнить свои обычные запросы.

Параметры

$results array|null обязательный

Верните массив данных пользователей, чтобы прервать пользовательский запрос WP, или null, чтобы позволить WP выполнить свои обычные запросы.

$query WP_User_Query обязательный

Экземпляр WP_User_Query (передаётся по ссылке).

Исходный код

wp-includes/class-wp-user-query.php:820

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

История изменений

Версия	Описание
5.1.0	Introduced.