wp_list_authors()
云策文档标注
概述
wp_list_authors() 函数用于列出网站的所有作者,支持多种参数自定义输出格式和内容,如排序、数量限制、显示文章计数等。开发者可通过参数控制是否输出为 HTML 列表或纯文本,并可选包含 RSS 链接。
关键要点
- 函数接受数组或字符串参数,用于定义排序方式(如 'name'、'post_count')、排序方向('ASC' 或 'DESC')、数量限制等。
- 默认行为包括排除 admin 账户、隐藏无文章作者,并可选择显示文章计数和 RSS 链接。
- 输出可通过 'echo' 参数控制直接输出或返回字符串,'style' 参数决定是否为列表格式。
- 包含两个过滤器:'wp_list_authors_args' 用于修改查询参数,'pre_wp_list_authors_post_counts_query' 用于短路文章计数查询。
- 函数内部使用 get_users() 获取作者列表,并结合数据库查询计算文章数量。
代码示例
wp_list_authors( array(
'show_fullname' => 1,
'optioncount' => 1,
'orderby' => 'post_count',
'order' => 'DESC',
'number' => 3
) );
原文内容
Lists all the authors of the site, with several options available.
Parameters
$argsstring|arrayoptional-
Array or string of default arguments.
orderbystringHow 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'.orderstringSorting direction for $orderby. Accepts'ASC','DESC'. Default'ASC'.numberintMaximum authors to return or display. Default empty (all authors).optioncountboolShow the count in parenthesis next to the author’s name. Default false.exclude_adminboolWhether to exclude the'admin'account, if it exists. Default true.show_fullnameboolWhether to show the author’s full name. Default false.hide_emptyboolWhether to hide any authors with no posts. Default true.feedstringIf not empty, show a link to the author’s feed and use this text as the alt parameter of the link. Default empty.feed_imagestringIf not empty, show a link to the author’s feed and use this image URL as clickable anchor. Default empty.feed_typestringThe feed type to link to. Possible values include'rss2','atom'.
Default is the value of get_default_feed() .echoboolWhether to output the result or instead return it. Default true.stylestringIf'list', each author is wrapped in an<li>element, otherwise the authors will be separated by commas.htmlboolWhether to list the items in HTML form or plaintext. Default true.excludeint[]|stringArray or comma/space-separated list of author IDs to exclude. Default empty.includeint[]|stringArray or comma/space-separated list of author IDs to include. Default empty.
Source
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;
}
}
Hooks
- apply_filters( ‘pre_wp_list_authors_post_counts_query’, int[]|false $post_counts, array $parsed_args )
-
Filters whether to short-circuit performing the query for author post counts.
- apply_filters( ‘wp_list_authors_args’, array $query_args, array $parsed_args )
-
Filters the query arguments for the list of all authors of the site.
Changelog
| Version | Description |
|---|---|
| 1.2.0 | Introduced. |
Skip to note 2 content
Codex
Authors full names and number of posts
This example displays a list of the site’s authors with the full name (first and last name) plus the number of posts for each author. Note the output is in descending order by the post count, and limited to three (3) authors/users. Also, and by default, it excludes the admin author, hides authors with no posts, and does not display the RSS feed or image.
wp_list_authors( array( 'show_fullname' => 1, 'optioncount' => 1, 'orderby' => 'post_count', 'order' => 'DESC', 'number' => 3 ) );Example output:
Andrew Anderson (48)Harriett Smith (42)Sally Smith (29)