WordPress下拉列表输出用户标签:wp_dropdown_users

背字根

WordPress模板标签wp_dropdown_users用于输出用户列表,与其他输出用户列表的函数比较,wp_dropdown_users()函数不是以<li>列表输出,而是<select>下拉列表。

wp_dropdown_users( string|array $args = '' )

函数参数

$args

数组或字符串值

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

$args = array(
	'show_option_all'         => null,
	'show_option_none'        => null,
	'hide_if_only_one_author' => null,
	'orderby'                 => 'display_name',
	'order'                   => 'ASC',
	'include'                 => null,
	'exclude'                 => null,
	'multi'                   => false,
	'show'                    => 'display_name',
	'echo'                    => true,
	'selected'                => false,
	'include_selected'        => false,
	'name'                    => 'user',
	'id'                      => null,
	'class'                   => null, 
	'blog_id'                 => $GLOBALS['blog_id'],
	'who'                     => null
);

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

show_option_all

字符串值,默认为空

在下拉列表的开始处添加一个value为0的<option>,该值指定<option>的文本,例如:所有用户

show_option_none

字符串值,默认为空

在下拉列表的开始处添加一个value为-1的<option>,该值指定<option>的文本。

orderby

字符串值,默认值:display_name

以什么方式排序

  • ID:用户ID
  • user_nicename:用户昵称
  • display_name:用户资料设置中,“公开显示为”指定的名称

order

字符串值,默认值:ASC

排序顺序

  • ASC:升序
  • DESC:降序

include

字符串值,默认为空

要显示的用户ID,多个ID用逗号分隔

exclude

字符串值,默认为空

要排除的用户ID,多个ID用逗号分隔

multi

布尔值,默认值:false

是否隐藏<select>标签的id属性,默认否。

show

字符串值,默认值:display_name

<option>文本的值,即用户能看到的列表项内容。

  • ID:用户ID
  • user_login:用户登录名
  • display_name:用户资料“公开显示为”指定的名称

echo

布尔值,默认值:1

默认直接输出用户列表,如果为0则只返回结果而不输出。

selected

整数型,默认值:false

指定一个用户ID,将为该<option>添加selected属性,即选中状态。

include_selected

布尔值,默认值:false

始终在下拉列表中包含所选的用户ID。

name

字符串值,默认值:user

<select>标签name属性的值,默认为user

id

字符串值,默认值:name参数指定的值

<select>标签id属性的值,默认为name参数指定的值

class

字符串值,默认为空

<select>标签class属性的值

blog_id

整数型,默认为当前博客的ID

实用于多站点

who

要查询的用户,目前仅支持“authors”,默认为所有用户。

函数使用示例

以ID排序显示用户列表,并在列表开头添加一个“所有用户”项

<?php
	$args = array(
		'show_option_all' => '所有用户',
		'orderby' => 'ID'
	);
	wp_dropdown_users($args);
?>

下面的代码输出一样的结果:

<?php wp_dropdown_users('show_option_all=所有用户&orderby=ID'); ?>

扩展阅读

wp_dropdown_users()函数位于:wp-includes/user.php

相关函数:

个赞
扫码关注背字根

一个热爱Web开发的大男孩