Описание функции wp_list_users()
Функция wp_list_users() генерирует и выводит список пользователей WordPress с возможностью фильтрации по ролям и другим параметрам. Используется для вывода пользователей в виде HTML-списка, включая дополнительные данные о каждом пользователе, такие как имя, email и роль.
Функция часто применяется в админ-панели или на пользовательских страницах для отображения информации о пользователях сайта.
Параметры
$args
Тип: array
Обязательный: Нет
По умолчанию: array()
Описание: Массив аргументов для настройки вывода списка пользователей
Возможные значения:
role: Название роли пользователя (например, ‘administrator’, ‘editor’)
orderby: login, nicename, email, registered, display_name
order: ASC, DESC
include: Массив ID пользователей для включения в список
exclude: Массив ID пользователей для исключения из списка
number: Количество пользователей для отображения (по умолчанию — все)
Возвращаемое значение
Тип: void
Описание: Функция выводит HTML-код списка пользователей напрямую, не возвращая значения
Возможные значения:
• HTML-список пользователей при успешном выполнении
• Ничего не выводится, если нет пользователей для отображения
Примеры использования
Выводит список всех пользователей без фильтрации
wp_list_users();
Список будет включать всех зарегистрированных пользователей
Выводит список пользователей с ролью ‘editor’, отсортированных по имени
$args = array(
'role' => 'editor',
'orderby' => 'display_name',
'order' => 'ASC'
);
wp_list_users($args);
Только редакторы будут отображены в списке
Проверка наличия пользователей перед выводом списка
$users = get_users();
if (empty($users)) {
echo 'Нет пользователей для отображения';
} else {
wp_list_users();
}
Сообщение будет отображено, если пользователей нет
Создает шорткод для вывода списка пользователей с ролью ‘subscriber’
function custom_user_list() {
$args = array(
'role' => 'subscriber'
);
wp_list_users($args);
}
add_shortcode('user_list', 'custom_user_list');
Можно использовать шорткод [user_list] в любом посте или странице
Безопасность
Валидация входных данных: Аргументы проходят валидацию внутри функции
Санитизация: Параметры очищаются WordPress перед использованием
Рекомендации: При выводе данных пользователей используйте esc_html() для защиты от XSS
— Связанные функции
Получает массив объектов WP_User
Получает текущего авторизованного пользователя
— Хуки
Фильтрует аргументы перед выводом списка пользователей
Фильтрует результаты после получения пользователей
— Примечания
– Ограничения
Не поддерживает сложные запросы, такие как выборка по мета-данным пользователя
– Частые проблемы
- Пустой результат при использовании некорректных параметров
- Проблемы с отображением при недостаточном количестве пользователей
