wp_list_users() │ WP 5.9.0

Виводить/отримує список імен (display_name) користувачів сайту у вигляді простого або LI списку. Можна вибрати низку параметрів для вибірки.

Хуків немає.

Повертає

Строку|null.

• При $echo = true(за замовчуванням) – Виводить HTML код на екран, при цьому повертає null.
• При $echo = falseповертає HTML код.

Шаблон використання

<?php
wp_list_users([
	'orderby' => 'name',
	'order' => 'ASC',
	'number' => '',
	'exclude_admin' => true,
	'show_fullname' => false,
	'feed' => '',
	'feed_image' => '',
	'feed_type' => '',
	'echo' => true,
	'style' => 'list',
	'html' => true,
	'exclude' => '',
	'include' => '',
]);
?>

Використання

wp_list_users($args);

$args
(рядок | масив)

Масив чи рядок аргументів для вибірки.

За замовчуванням: array()

• orderby (рядок)
  Як сортувати користувачів. Може бути:

  nicename
  email
  url
  registered
  user_nicename
  user_email
  user_url
  user_registered
  name
  display_name
  post_count
  ID
  meta_value
  user_login

  За замовчуванням: ‘name’

• order (рядок)
  Напрямок сортування для $orderby. Можливо: ASC, DESC.
  За замовчуванням: ‘ASC’
• number (int)
  Максимальна кількість користувачів, які отримає функція.
  Типово: 0 (all users)
• exclude_admin (true|false)
  Чи потрібно виключити адміністраторів – обліковий запис ‘admin’.
  Типово: false
• show_fullname (true|false)
  Показувати повне ім’я користувача. За промовчанням показуєте display_name. Якщо включити цей параметр, то буде показана комбінація first_name last_name, тільки якщо ці поля заповнені у користувача, інакше так і буде показано display_name.
  Типово: false
• feed (рядок)
  Якщо не порожньо, показувати посилання на стрічку (фід) користувача та використовувати текст вказаний у цьому параметрі як параметр анкору посилання. Якщо вказано УРЛ feed_image, то текст цього параметра буде вказано в alt аттрибуде посилання на фід.
  За замовчуванням: ”
• feed_image (рядок)
  Якщо не порожньо, показувати IMG як анкор посилання фіда. Вказаний тут URL це посилання на картку.
  За замовчуванням: ”
• feed_type (рядок)
  Тип фіда, на який потрібно посилатися, наприклад ‘RSS2’.
  За замовчуванням: default feed type
• echo (true|false)
  Виводити результат чи повертати його.
  Типово: true
• style (рядок)
  Якщо ‘list’, то кожен користувач буде обернутий в елемент <li>, в іншому випадку користувачі будуть розділені комами.
  За замовчуванням: ‘list’
• html (true|false)
  Виводити список елементів у формі HTML або у вигляді звичайного тексту. Якщо вказати false, всі параметри які мають на увазі HTML розмітку перестануть працювати – це feed, feed_image, list.
  Типово: true
• exclude (рядок | масив)
  Масив ID користувачів яких потрібно виключити зі списку. Можна вказати рядком, де ID розділити пробілами або комами.
  За замовчуванням: ”
• include (рядок | масив)
  Масив ID користувачів яких потрібно показати у списку. Можна вказати рядком, де ID розділити пробілами або комами.
  За замовчуванням: ”

Приклади

$users_list = wp_list_users([
	'number' => 3,
	'echo' => false,
	'style' => 'list',
]);

echo htmlspecialchars( $users_list );

/*
style => 'list':

	<li>Wasija</li>
	<li>stas</li>
	<li>anastasiiik</li>
*/

/*
style => '' або 'html' => false:

	Wasija, stas, anastasiiik
*/

Додати свій приклад