描述
用来显示网站的作者(用户)列表,如果用户发布有文章,就会将作者名字链接到他们的文章。还可以显示每个作者的文章数和RSS订阅链接。
用法
<?php wp_list_authors( $args ); ?>
默认用法
<?php $args = array(
'orderby' => 'name',
'order' => 'ASC',
'number' => null,
'optioncount' => false,
'exclude_admin' => true,
'show_fullname' => false,
'hide_empty' => true,
'echo' => true,
'feed' => [empty string],
'feed_image' => [empty string],
'feed_type' => [empty string],
'style' => list,
'html' => true ); ?>
默认用法显示的内容:
- 名称显示(显示名称)顺序:升序
- 显示的用户数量没有限制
- 不显示用户的文章数
- 从列表中排除“管理员”
- 显示作者的“公开显示为”的名称
- 排除没有文章的用户
- 显示结果
- 没有定义作者的Feed文本、图像或Feed类型
- 该风格以列表格式显示
- 使用有效的HTML返回项目
参数
orderby
(字符串)字段用于对结果进行排序。这种说法是3.1版本中引入。有效值:
- name – 根据 users 这个表的 display_name 进行排序 – 默认
- email – 根据 users 这个表的user_email 进行排序
- url – 根据 users 这个表的 user_url 进行排序
- registered – 根据 users 这个表的 user_registered 日期 进行排序
- id – 根据 users 这个表的 ID 进行排序
- user_login – 根据 users 这个表的 user_login 进行排序
- post_count – 根据用户的文章数进行排序
order
(字符串)令结果递增或递减。这种说法是3.1版本中引入。有效值:
- ASC – 升序(默认)
- DESC – 降序
number
(整数)显示用户的最大数量。缺省情况下,显示的用户的数目是没有限制的。这种说法是3.1版本中引入。
optioncount
(布尔)显示每个作者发表的文章。有效值:
- 1 (true)
- 0 (false) – 默认
exclude_admin
(布尔)排除“管理员”(登录名是admin)帐户列表。有效值:
- 1 (true) – 默认
- 0 (false)
show_fullname
(布尔)显示完整的(第一个和最后一个)作者名称。如果为false,显示“公开显示为”的名称。有效值:
- 1 (true)
- 0 (false) – 默认
hide_empty
(布尔)不显示没有文章的作者。有效值:
- 1 (true) – 默认
- 0 (false)
echo
(布尔)显示结果。有效值:
- 1 (true) – 默认
- 0 (false)
feed
(字符串)链接到每个作者的RSS feed 所显示的文字。默认是没有文字,而且不显示Feed。
feed_image
(字符串)图想的路径/文件名。这可以作为一个链接到每个作者的RSS feed,覆盖feed参数。
feed_type
(字符串)Feed的类型,默认空字符串。有效值:
- – 默认
- rss2
- atom
- rss
- rdf
style
(字符串)作者列表的显示样式。一个列表,默认情况下,显示了作者作为一个无序列表,而没有产生任何特殊的显示方式(用逗号分隔每个列表项)。如果html是false,这个选项被忽略。有效值:
- list – 默认
- none
html
(布尔)作者列表以html或明文输出。默认设置为true。如果html是false,样式设置将被忽略,而且返回列表项,用逗号隔开。有效值:
- 1 (true) – 默认
- 0 (false)
例子
显示作者名称和文章数
这个例子显示一个列表的网站的作者的全名(第一个和最后一个名字),以及每个作者的文章数量。作者列表是根据每个作者的文章数量进行降序排列,并只显示前三名作者/用户。此外,默认情况下,它排除了admin 管理员,隐藏没有文章的作者,并且不显示RSS feed或图像。
<?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)
函数历史
始见于 1.2.0 版本
2.8版本:添加 ‘style’ 和 ‘html’ 参数
3.1版本:添加 ‘orderby’, ‘order’, 和 ‘number’ 参数
源文件
wp_list_authors() 位于 wp-includes/author-template.php.
这个好像不支持自定义文章类型,如何获得自定义文章类型的作者列表(按文章数目排列)?
wp_list_authors这个函数可以得到“作者(发表文章总数)”,如果想得到“作者(置顶文章总数)”,该怎么实现?