wp_list_users() │ WP 5.9.0

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

1 раз — 0.0159421 сек (тормоз) | 50000 раз — 208.82 сек (тормоз)
Хуки из функции

Возвращает

Строку|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 разделить пробелами или запятыми.
    По умолчанию: ''

Примеры

0

#1 Демонстрация того, что выводит функция 

$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
*/

Список изменений

С версии 5.9.0 Введена.

Код wp_list_users() WP 6.5.2

wp-includes/user.php 
function wp_list_users( $args = array() ) {
	$defaults = array(
		'orderby'       => 'name',
		'order'         => 'ASC',
		'number'        => '',
		'exclude_admin' => true,
		'show_fullname' => false,
		'feed'          => '',
		'feed_image'    => '',
		'feed_type'     => '',
		'echo'          => true,
		'style'         => 'list',
		'html'          => true,
		'exclude'       => '',
		'include'       => '',
	);

	$parsed_args = wp_parse_args( $args, $defaults );

	$return = '';

	$query_args           = wp_array_slice_assoc( $parsed_args, array( 'orderby', 'order', 'number', 'exclude', 'include' ) );
	$query_args['fields'] = 'ids';

	/**
	 * Filters the query arguments for the list of all users of the site.
	 *
	 * @since 6.1.0
	 *
	 * @param array $query_args  The query arguments for get_users().
	 * @param array $parsed_args The arguments passed to wp_list_users() combined with the defaults.
	 */
	$query_args = apply_filters( 'wp_list_users_args', $query_args, $parsed_args );

	$users = get_users( $query_args );

	foreach ( $users as $user_id ) {
		$user = get_userdata( $user_id );

		if ( $parsed_args['exclude_admin'] && 'admin' === $user->display_name ) {
			continue;
		}

		if ( $parsed_args['show_fullname'] && '' !== $user->first_name && '' !== $user->last_name ) {
			$name = sprintf(
				/* translators: 1: User's first name, 2: Last name. */
				_x( '%1$s %2$s', 'Display name based on first name and last name' ),
				$user->first_name,
				$user->last_name
			);
		} else {
			$name = $user->display_name;
		}

		if ( ! $parsed_args['html'] ) {
			$return .= $name . ', ';

			continue; // No need to go further to process HTML.
		}

		if ( 'list' === $parsed_args['style'] ) {
			$return .= '<li>';
		}

		$row = $name;

		if ( ! empty( $parsed_args['feed_image'] ) || ! empty( $parsed_args['feed'] ) ) {
			$row .= ' ';
			if ( empty( $parsed_args['feed_image'] ) ) {
				$row .= '(';
			}

			$row .= '<a href="' . get_author_feed_link( $user->ID, $parsed_args['feed_type'] ) . '"';

			$alt = '';
			if ( ! empty( $parsed_args['feed'] ) ) {
				$alt  = ' alt="' . esc_attr( $parsed_args['feed'] ) . '"';
				$name = $parsed_args['feed'];
			}

			$row .= '>';

			if ( ! empty( $parsed_args['feed_image'] ) ) {
				$row .= '<img src="' . esc_url( $parsed_args['feed_image'] ) . '" style="border: none;"' . $alt . ' />';
			} else {
				$row .= $name;
			}

			$row .= '</a>';

			if ( empty( $parsed_args['feed_image'] ) ) {
				$row .= ')';
			}
		}

		$return .= $row;
		$return .= ( 'list' === $parsed_args['style'] ) ? '</li>' : ', ';
	}

	$return = rtrim( $return, ', ' );

	if ( ! $parsed_args['echo'] ) {
		return $return;
	}
	echo $return;
}

Пользователи (_user)

Остальное