Описание функции get_users()
Функция get_users() получает список пользователей WordPress с возможностью фильтрации и сортировки. Она позволяет извлекать пользователей по различным критериям, таким как роль, статус, мета-данные и другие параметры. Функция возвращает массив объектов WP_User, что обеспечивает удобный доступ к свойствам пользователей, таким как имя, email, роль и мета-данные.
Результаты могут быть полезны для отображения списка пользователей, управления правами доступа и других задач, связанных с пользователями.
Параметры
$args
Тип: array
Обязательный: Нет
По умолчанию: array()
Описание: Массив аргументов для получения пользователей
Возможные значения:
role: Название роли (например, ‘administrator’)
orderby: login, ID, display_name, user_registered
order: ASC, DESC
number: Количество пользователей для получения
offset: Смещение для получения пользователей
meta_key: Ключ мета-данных для фильтрации
meta_value: Значение мета-данных для фильтрации
include: Массив ID пользователей для включения
exclude: Массив ID пользователей для исключения
Возвращаемое значение
Тип: array
Описание: Массив объектов WP_User, представляющих пользователей
Возможные значения:
• Массив объектов WP_User при успешном выполнении
• Пустой массив если пользователи не найдены
• WP_Error в случае ошибки
Примеры использования
Базовый пример получения всех пользователей
$users = get_users();
foreach($users as $user) {
echo $user->display_name.', ';
}
Отображает имена всех пользователей
Получение подписчиков, отсортированных по дате регистрации
$args = array(
'role' => 'subscriber',
'orderby' => 'user_registered',
'order' => 'DESC'
);
$users = get_users($args);
Показывает подписчиков, зарегистрированных недавно
Проверка на наличие ошибок при получении пользователей
$users = get_users();
if (is_wp_error($users)) {
echo 'Ошибка: ' . $users->get_error_message();
} else {
// Обработка пользователей
}
Выводит сообщение об ошибке, если таковая имеется
Безопасность
Валидация входных данных: Все параметры проходят валидацию внутри функции
Санитизация: Параметры автоматически очищаются WordPress
Рекомендации: При выводе данных используйте esc_html() для имен пользователей
— Связанные функции
Получает одного пользователя по ID или логину
Получает текущего пользователя
— Хуки
Фильтрует аргументы перед запросом пользователей
Фильтрует результаты после получения пользователей
— Примечания
– Ограничения
Возвращает только публичных пользователей по умолчанию
– Частые проблемы
- Пустой результат при неправильных параметрах
- Проблемы с мета-данными при неверных настройках meta_key/meta_value
