eurobyte.ru - мощные сервера с Дата-центрами в Нидерландах и Москве. От 159 ₽/мес.

wp_list_authors()WP 1.2.0

Выводит список авторов блога, как ссылки на их посты, если посты существуют.

Также можно указать вывод ссылки на RSS фид каждого автора и количество записей у каждого автора.

Возвращает

null|Строку. Ничего при echo = true. Список авторов при echo = false.

Шаблон использования

$args = array(
	'orderby'       => 'name',
	'order'         => 'ASC',
	'number'        => null,
	'optioncount'   => false,
	'exclude_admin' => true,
	'show_fullname' => false,
	'hide_empty'    => true,
	'echo'          => true,
	'feed'          => '',
	'feed_image'    => '',
	'feed_type'     => '',
	'style'         => list,
	'html'          => ''
);

wp_list_authors( $args );

Использование

<?php wp_list_authors( $args ); ?>
$args(строка|массив)

Параметры отвечающие за вывод.

  • orderby(строкa)
    Поле по которому будет сортироваться результат. C версии 3.1. Доступные поля:

    • name - сортировать по отображаемому имени (поле display_name в таблице users - по умолчанию).
    • email - по адресу емаил (поле таблицы user_email).
    • url - по адресу URL user_url.
    • registered - по полю user_registered.
    • id - по ID пользователя.
    • user_login - по логину пользователя (поле user_login).
    • post_count - по количеству записей у пользователя.
      По умолчанию: 'name'
  • order(строка)
    В каком порядке сортировать: ASC - по порядку, DESC - в обратном порядке. С версии 3.1.
    По умолчанию: 'ASC'

  • number(число)
    Максимальное количество пользователей которое будет показано (лимит). С версии 3.1.
    По умолчанию: без ограничения

  • optioncount(логический)
    Показывать количество постов каждого пользователя: 1 (true) - показывать, 0 (false) - не показывать.
    По умолчанию: false

  • exclude_admin(логический)
    Исключить из списка регистрационную запись с логином admin: 1 (true) - исключить, 0 (false) - не исключать (по умолчанию).
    По умолчанию: false

  • show_fullname(логический)
    Показывать полное имя (имя, фамилию) автора, если стоит false, будет показано имя которое выбрано для отображения.
    По умолчанию: false

  • hide_empty(логический)
    Не показывать авторов у которых нет записей: 1 (true) - показывать, 0 (false) - не показывать.
    По умолчанию: true

  • echo(логический)
    Выводить на экран или возвращать для обработки: 1 (true) - выводить, 0 (false) - возвращать.
    По умолчанию: true

  • feed(строка)
    Текст для ссылки на фид каждого автора, если текст не передан ссылка на фид не будет выводиться.
    По умолчанию: ''

  • feed_image(строка)
    Пусть/ссылка на картинку, которая будет показана как ссылка на фид каждого автора. Альтернатива параметру feed.
    По умолчанию: ''

  • feed_type(строка)
    Тип фида. Пустая строка - фид установленный на блоге по умолчанию, возможные значения: rss2, atom, rss, rdf.
    По умолчанию: ''

  • style(строка)
    В каком формате выводить список. По умолчанию выводится в формате list - ul список, если указать none, то авторы будут показаны через запятую. Этот параметр работает, только если включен параметр html.
    По умолчанию: 'list'

  • html(логический)
    Включает или отключает форматирование html. По умолчанию форматирование включено (true), если его выключить (false), то список будет выведен как ссылки на авторов через запятую.
    По умолчанию: true

По умолчанию: пустая строка (предустановленные)

Примеры

0

#1 Получим список авторов сайта

Список выводит авторов сайта, показывая:

  • полное имя (show_fullname=1).
  • количество записей у каждого автора (optioncount=1).
  • Сортировка происходит в обратном порядке (order=DESC) по количеству записей у каждого автора (orderby=post_count).
  • Вывод ограничен 3-мя авторами (number=3).
  • Так же, по умолчанию из списка исключен автора с ником admin.
  • исключены авторы не имеющие записей.
  • не показываются ссылки на RSS фиды.
<?php wp_list_authors( 'show_fullname=1&optioncount=1&orderby=post_count&order=DESC&number=3' ); ?>

В результате мы получим нечто подобное:

Andrew Anderson (48)
Harriett Smith (42)
Sally Smith (29)

Заметки

  • Global. wpdb. $wpdb WordPress database abstraction object.

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

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

Код wp_list_authors() WP 6.7.1

function wp_list_authors( $args = '' ) {
	global $wpdb;

	$defaults = array(
		'orderby'       => 'name',
		'order'         => 'ASC',
		'number'        => '',
		'optioncount'   => false,
		'exclude_admin' => true,
		'show_fullname' => false,
		'hide_empty'    => true,
		'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 authors 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_authors() combined with the defaults.
	 */
	$query_args = apply_filters( 'wp_list_authors_args', $query_args, $parsed_args );

	$authors     = get_users( $query_args );
	$post_counts = array();

	/**
	 * Filters whether to short-circuit performing the query for author post counts.
	 *
	 * @since 6.1.0
	 *
	 * @param int[]|false $post_counts Array of post counts, keyed by author ID.
	 * @param array       $parsed_args The arguments passed to wp_list_authors() combined with the defaults.
	 */
	$post_counts = apply_filters( 'pre_wp_list_authors_post_counts_query', false, $parsed_args );

	if ( ! is_array( $post_counts ) ) {
		$post_counts       = array();
		$post_counts_query = $wpdb->get_results(
			"SELECT DISTINCT post_author, COUNT(ID) AS count
			FROM $wpdb->posts
			WHERE " . get_private_posts_cap_sql( 'post' ) . '
			GROUP BY post_author'
		);

		foreach ( (array) $post_counts_query as $row ) {
			$post_counts[ $row->post_author ] = $row->count;
		}
	}

	foreach ( $authors as $author_id ) {
		$posts = isset( $post_counts[ $author_id ] ) ? $post_counts[ $author_id ] : 0;

		if ( ! $posts && $parsed_args['hide_empty'] ) {
			continue;
		}

		$author = get_userdata( $author_id );

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

		if ( $parsed_args['show_fullname'] && $author->first_name && $author->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' ),
				$author->first_name,
				$author->last_name
			);
		} else {
			$name = $author->display_name;
		}

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

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

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

		$link = sprintf(
			'<a href="%1$s" title="%2$s">%3$s</a>',
			esc_url( get_author_posts_url( $author->ID, $author->user_nicename ) ),
			/* translators: %s: Author's display name. */
			esc_attr( sprintf( __( 'Posts by %s' ), $author->display_name ) ),
			$name
		);

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

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

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

			$link .= '>';

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

			$link .= '</a>';

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

		if ( $parsed_args['optioncount'] ) {
			$link .= ' (' . $posts . ')';
		}

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

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

	if ( $parsed_args['echo'] ) {
		echo $return;
	} else {
		return $return;
	}
}
4 комментария
    Войти