wp_list_authors( string|array $args = '' )

List all the authors of the site, with several options available.

Parameters

$args

(string|array) (Optional) Array or string of default arguments.

'orderby'
(string) How to sort the authors. Accepts 'nicename', 'email', 'url', 'registered', 'user_nicename', 'user_email', 'user_url', 'user_registered', 'name', 'display_name', 'post_count', 'ID', 'meta_value', 'user_login'. Default 'name'.
'order'
(string) Sorting direction for $orderby. Accepts 'ASC', 'DESC'. Default 'ASC'.
'number'
(int) Maximum authors to return or display. Default empty (all authors).
'optioncount'
(bool) Show the count in parenthesis next to the author's name. Default false.
'exclude_admin'
(bool) Whether to exclude the 'admin' account, if it exists. Default false.
'show_fullname'
(bool) Whether to show the author's full name. Default false.
'hide_empty'
(bool) Whether to hide any authors with no posts. Default true.
'feed'
(string) If not empty, show a link to the author's feed and use this text as the alt parameter of the link.
'feed_image'
(string) If not empty, show a link to the author's feed and use this image URL as clickable anchor.
'feed_type'
(string) The feed type to link to, such as 'rss2'. Defaults to default feed type.
'echo'
(bool) Whether to output the result or instead return it. Default true.
'style'
(string) If 'list', each author is wrapped in an <li> element, otherwise the authors will be separated by commas.
'html'
(bool) Whether to list the items in HTML form or plaintext. Default true.
'exclude'
(array|string) Array or comma/space-separated list of author IDs to exclude.
'include'
(array|string) Array or comma/space-separated list of author IDs to include.

Default value: ''

Return

(string|void) The output, if echo is set to false.

Source

File: wp-includes/author-template.php

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' => ''
	);

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

	$return = '';

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

	$author_count = array();
	foreach ( (array) $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" ) as $row ) {
		$author_count[$row->post_author] = $row->count;
	}
	foreach ( $authors as $author_id ) {
		$author = get_userdata( $author_id );

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

		$posts = isset( $author_count[$author->ID] ) ? $author_count[$author->ID] : 0;

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

		if ( $args['show_fullname'] && $author->first_name && $author->last_name ) {
			$name = "$author->first_name $author->last_name";
		} else {
			$name = $author->display_name;
		}

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

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

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

		$link = sprintf( '<a href="%1$s" title="%2$s">%3$s</a>',
			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( $args['feed_image'] ) || ! empty( $args['feed'] ) ) {
			$link .= ' ';
			if ( empty( $args['feed_image'] ) ) {
				$link .= '(';
			}

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

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

			$link .= '>';

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

			$link .= '</a>';

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

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

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

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

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

Expand Source Code View on GitHub

Uses

Uses
Uses	Description
wp-includes/author-template.php: get_author_posts_url()	Retrieve the URL to the author page for the user with the ID provided.
wp-includes/l10n.php: __()	Retrieve the translation of $text.
wp-includes/pluggable.php: get_userdata()	Retrieve user info by user ID.
wp-includes/link-template.php: get_author_feed_link()	Retrieves the feed link for a given author.
wp-includes/user.php: get_users()	Retrieve list of users matching criteria.
wp-includes/wp-db.php: wpdb::get_results()	Retrieve an entire SQL result set from the database (i.e., many rows)
wp-includes/post.php: get_private_posts_cap_sql()	Retrieve the private post SQL based on capability.
wp-includes/formatting.php: esc_attr()	Escaping for HTML attributes.
wp-includes/formatting.php: esc_url()	Checks and cleans a URL.
wp-includes/functions.php: wp_parse_args()	Merge user defined arguments into defaults array.
wp-includes/functions.php: wp_array_slice_assoc()	Extract a slice of an array, given a list of keys.

Show 6 more uses Hide more uses

Used By

Used By
Used By	Description
wp-includes/deprecated.php: list_authors()	Lists authors.

Changelog

Changelog
Version	Description
WP-1.2.0	Introduced.