WordPress作者列表标签:wp_list_authors

背字根

WordPress模板标签wp_list_authors输出用户列表,并给出用户页面链接,默认以<li>列表输出。

wp_list_authors( string|array $args = '' )

函数参数

$args

数组或字符串值

wp_list_authors()函数$args参数默认的值如下:

$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,
	'exclude'		=> [empty string],
	'include'		=> [empty string]
);

wp_list_authors()函数$args参数可用的值如下:

orderby

字符串值,默认值:name

指定输出的用户列表以哪个字段排列顺序

  • name:以users表display_name字段排列顺序,也就是用户资料“公开显示为”
  • email:以用户邮件地址排列
  • url:以用户网址排列
  • registered:以注册日期排列
  • id:以用户ID排列
  • user_login:以用户登录账号排列
  • post_count:以用户发表的文章数量排列

order

字符串值,默认值:ASC

指定输出的用户列表的排序方式

  • ASC:升序
  • DESC:降序

number

整数型

指定要输出的用户数量

optioncount

布尔值,默认值:false

是否显示作者发表的文章总数

  • 1(true):显示作者发表的文章总数
  • 0(false):不显示作者发表的文章总数

exclude_admin

布尔值,默认值:true

排除名称为“admin”的用户,只有用户资料设置中“公开显示为”的名称为“admin”才被排除

  • 1(true):排除“admin”用户
  • 0(false):不排除“admin”用户

show_fullname

布尔值,默认值:false

显示用户的姓名而不是用户资料设置“公开显示为”中指定的名称

  • 1(true):显示
  • 0(false):不显示,此时显示用户资料设置“公开显示为”中设定的名称

hide_empty

布尔值,默认值:true

是否隐藏没有发表过文章的用户

  • 1(true):隐藏
  • 0(false):显示

feed

字符串值,默认为空

提供一个文本作为用户feed链接的锚文本,默认不显示用户feed链接

feed_image

字符串值,默认为空

提供一个图片的路径作为用户feed链接图片,并且会覆盖feed的设置

feed_type

字符串值,默认为空

feed的类型,可选的值有:

  • -:默认值
  • rss2
  • atom
  • rss
  • rdf

style

字符串值,默认值:list

输出用户列表的HTML标签类型

  • list:以<li>列表输出,不包括<ul>标签
  • none:只输出链接,没有<li>标签,每个链接之间用逗号分隔

html

布尔值,默认值:true

是否输出HTML标签,如果为false,只输出文本,不同用户之前用逗号分隔

  • 1(true):输出HTML标签
    0(false):只输出文本,不包含<li>标签以及<a>标签,不同用户之前用逗号分隔

exclude

数组

要排除的用户ID,例如:array(1,6,9)

include

数组

要显示的用户ID,例如:array(1,3,5)

函数使用示例

显示10个用户,并排除ID为1的用户,通常管理员的ID为1,同时即使没有发表过文章的用户也显示出来

<?php
	$args = array(
		'number' => 10,
		'exclude' => array(1),
		'hide_empty' => false
	);
	wp_list_authors($args);
?>

下面的写法也是一样的效果:

<?php wp_list_authors('number=10&exclude=1&hide_empty=0'); ?>

不同之处在于,true写成了1,false写成了0

如果要排除多个用户,则这样写:

<?php wp_list_authors('number=10&exclude=1,2,3&hide_empty=0'); ?>

扩展阅读

wp_list_authors()函数位于:wp-includes/author-template.php

相关函数:

个赞
扫码关注背字根

一个热爱Web开发的大男孩