Функция wp_list_users() позволяет вывести список пользователей сайта с различными опциями для управления их отображением. С помощью этой функции можно настроить сортировку, фильтрацию пользователей, включение или исключение определенных аккаунтов, а также множество других параметров для более гибкого вывода.
wp_list_users( string|array $args = array() ): string|null
Параметры
- $args (string|array): Массив или строка с аргументами для настройки отображения. Доступные параметры:
- orderby (string): Поле, по которому будут сортироваться пользователи. Допустимые значения:
nicename,email,url,registered,user_nicename,user_email,user_url,user_registered,name,display_name,post_count,ID,meta_value,user_login. По умолчанию:'name'.
- order (string): Направление сортировки. Допустимые значения:
ASC(по возрастанию) илиDESC(по убыванию). По умолчанию:ASC. - number (int): Максимальное количество пользователей, которое будет показано. По умолчанию: показываются все пользователи.
- exclude_admin (bool): Исключать ли учетную запись ‘admin’. По умолчанию:
false. - show_fullname (bool): Показывать ли полное имя пользователя. По умолчанию отображается
display_name. Если включено, показывается комбинацияfirst_nameиlast_name(если заполнены). По умолчанию:false. - feed (string): Если не пусто, показывать ссылку на фид пользователя и использовать текст как анкор. По умолчанию: пусто.
- feed_image (string): Путь к изображению, которое будет использоваться как ссылка на фид пользователя. По умолчанию: пусто.
- feed_type (string): Тип фида. Например,
'rss2'. По умолчанию используется тип фида по умолчанию для сайта. - echo (bool): Выводить результат на экран или возвращать его. По умолчанию:
true. - style (string): Формат вывода. Если
'list', каждый пользователь будет обернут в элемент<li>. Если не указано, пользователи будут разделены запятыми. По умолчанию:'list'. - html (bool): Выводить ли список в HTML или как простой текст. Если
false, HTML разметка отключается. По умолчанию:true. - exclude (string|array): Массив ID пользователей, которых нужно исключить из списка. Можно указать строкой, разделив ID пробелами или запятыми.
- include (string|array): Массив ID пользователей, которых нужно включить в список. Можно указать строкой, разделив ID пробелами или запятыми. По умолчанию: пусто.
- orderby (string): Поле, по которому будут сортироваться пользователи. Допустимые значения:
Возвращаемое значение
- string|null: Если
echoустановлено вfalse, функция вернет HTML код. Еслиechoустановлено вtrue, результат будет выведен на экран, и функция вернетnull.
Пример 1: Список пользователей с сортировкой по имени
wp_list_users( array(
'orderby' => 'name',
'order' => 'ASC',
'number' => 5,
'show_fullname' => false,
'style' => 'list'
) );
В этом примере выводится список пяти пользователей, отсортированных по имени в порядке возрастания. Полные имена не показываются.
Пример 2: Список пользователей с полными именами и ссылками на RSS
wp_list_users( array(
'show_fullname' => true,
'feed' => 'RSS Feed',
'feed_image' => 'https://example.com/feed-icon.png',
'number' => 3
) );
Пример 3: Исключение администратора и других пользователей
wp_list_users( array(
'exclude_admin' => true,
'exclude' => '2,3'
) );
В этом примере из списка исключены администратор и пользователи с ID 2 и 3.
Заключение
Функция wp_list_users() предоставляет гибкость в отображении пользователей WordPress с возможностью настройки различных параметров, таких как сортировка, включение и исключение пользователей, вывод фидов и другие. Используя эту функцию, можно легко адаптировать вывод пользователей под нужды вашего проекта.
