wp_dropdown_users() – Function | Developer.WordPress.org

Creates dropdown HTML content of users.

Description

The content can either be displayed, which it is by default, or retrieved by setting the ‘echo’ argument to false. The ‘include’ and ‘exclude’ arguments are optional; if they are not specified, all users will be displayed. Only one can be used in a single call, either ‘include’ or ‘exclude’, but not both.

Parameters

$argsarray|stringoptional

Array or string of arguments to generate a drop-down of users.
See WP_User_Query::prepare_query() for additional available arguments.

show_option_all string
Text to show as the drop-down default (all).
show_option_none string
Text to show as the drop-down default when no users were found.
option_none_value int|string
Value to use for $show_option_none when no users were found. Default -1.
hide_if_only_one_author string
Whether to skip generating the drop-down if only one user was found.
orderby string
Field to order found users by. Accepts user fields.
Default 'display_name'.
order string
Whether to order users in ascending or descending order. Accepts 'ASC' (ascending) or 'DESC' (descending).
Default 'ASC'.
include int[]|string
Array or comma-separated list of user IDs to include.
exclude int[]|string
Array or comma-separated list of user IDs to exclude.
multi bool|int
Whether to skip the ID attribute on the 'select' element.
Accepts 1|true or 0|false. Default 0|false.
show string
User data to display. If the selected item is empty then the 'user_login' will be displayed in parentheses.
Accepts any user field, or 'display_name_with_login' to show the display name with user_login in parentheses.
Default 'display_name'.
echo int|bool
Whether to echo or return the drop-down. Accepts 1|true (echo) or 0|false (return). Default 1|true.
selected int
Which user ID should be selected. Default 0.
include_selected bool
Whether to always include the selected user ID in the drop- down. Default false.
name string
Name attribute of select element. Default 'user'.
id string
ID attribute of the select element. Default is the value of $name.
class string
Class attribute of the select element.
blog_id int
ID of blog (Multisite only). Default is ID of the current blog.
who string
Deprecated, use $capability instead.
Which type of users to query. Accepts only an empty string or 'authors'. Default empty (all users).
role string|string[]
An array or a comma-separated list of role names that users must match to be included in results. Note that this is an inclusive list: users must match *each* role.
role__in string[]
An array of role names. Matched users must have at least one of these roles. Default empty array.
role__not_in string[]
An array of role names to exclude. Users matching one or more of these roles will not be included in results. Default empty array.
capability string|string[]
An array or a comma-separated list of capability names that users must match to be included in results. Note that this is an inclusive list: users must match *each* capability.
Does NOT work for capabilities not in the database or filtered via 'map_meta_cap'.
capability__in string[]
An array of capability names. Matched users must have at least one of these capabilities.
Does NOT work for capabilities not in the database or filtered via 'map_meta_cap'. Default empty array.
capability__not_in string[]
An array of capability names to exclude. Users matching one or more of these capabilities will not be included in results.
Does NOT work for capabilities not in the database or filtered via 'map_meta_cap'. Default empty array.

Default:''

Return

string HTML dropdown list of users.

Source

function wp_dropdown_users( $args = '' ) {
	$defaults = array(
		'show_option_all'         => '',
		'show_option_none'        => '',
		'hide_if_only_one_author' => '',
		'orderby'                 => 'display_name',
		'order'                   => 'ASC',
		'include'                 => '',
		'exclude'                 => '',
		'multi'                   => 0,
		'show'                    => 'display_name',
		'echo'                    => 1,
		'selected'                => 0,
		'name'                    => 'user',
		'class'                   => '',
		'id'                      => '',
		'blog_id'                 => get_current_blog_id(),
		'who'                     => '',
		'include_selected'        => false,
		'option_none_value'       => -1,
		'role'                    => '',
		'role__in'                => array(),
		'role__not_in'            => array(),
		'capability'              => '',
		'capability__in'          => array(),
		'capability__not_in'      => array(),
	);

	$defaults['selected'] = is_author() ? get_query_var( 'author' ) : 0;

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

	$query_args = wp_array_slice_assoc(
		$parsed_args,
		array(
			'blog_id',
			'include',
			'exclude',
			'orderby',
			'order',
			'who',
			'role',
			'role__in',
			'role__not_in',
			'capability',
			'capability__in',
			'capability__not_in',
		)
	);

	$fields = array( 'ID', 'user_login' );

	$show = ! empty( $parsed_args['show'] ) ? $parsed_args['show'] : 'display_name';
	if ( 'display_name_with_login' === $show ) {
		$fields[] = 'display_name';
	} else {
		$fields[] = $show;
	}

	$query_args['fields'] = $fields;

	$show_option_all   = $parsed_args['show_option_all'];
	$show_option_none  = $parsed_args['show_option_none'];
	$option_none_value = $parsed_args['option_none_value'];

	/**
	 * Filters the query arguments for the list of users in the dropdown.
	 *
	 * @since 4.4.0
	 *
	 * @param array $query_args  The query arguments for get_users().
	 * @param array $parsed_args The arguments passed to wp_dropdown_users() combined with the defaults.
	 */
	$query_args = apply_filters( 'wp_dropdown_users_args', $query_args, $parsed_args );

	$users = get_users( $query_args );

	$output = '';
	if ( ! empty( $users ) && ( empty( $parsed_args['hide_if_only_one_author'] ) || count( $users ) > 1 ) ) {
		$name = esc_attr( $parsed_args['name'] );
		if ( $parsed_args['multi'] && ! $parsed_args['id'] ) {
			$id = '';
		} else {
			$id = $parsed_args['id'] ? " id='" . esc_attr( $parsed_args['id'] ) . "'" : " id='$name'";
		}
		$output = "<select name='{$name}'{$id} class='" . $parsed_args['class'] . "'>\n";

		if ( $show_option_all ) {
			$output .= "\t<option value='0'>$show_option_all</option>\n";
		}

		if ( $show_option_none ) {
			$_selected = selected( $option_none_value, $parsed_args['selected'], false );
			$output   .= "\t<option value='" . esc_attr( $option_none_value ) . "'$_selected>$show_option_none</option>\n";
		}

		if ( $parsed_args['include_selected'] && ( $parsed_args['selected'] > 0 ) ) {
			$found_selected          = false;
			$parsed_args['selected'] = (int) $parsed_args['selected'];

			foreach ( (array) $users as $user ) {
				$user->ID = (int) $user->ID;
				if ( $user->ID === $parsed_args['selected'] ) {
					$found_selected = true;
				}
			}

			if ( ! $found_selected ) {
				$selected_user = get_userdata( $parsed_args['selected'] );
				if ( $selected_user ) {
					$users[] = $selected_user;
				}
			}
		}

		foreach ( (array) $users as $user ) {
			if ( 'display_name_with_login' === $show ) {
				/* translators: 1: User's display name, 2: User login. */
				$display = sprintf( _x( '%1$s (%2$s)', 'user dropdown' ), $user->display_name, $user->user_login );
			} elseif ( ! empty( $user->$show ) ) {
				$display = $user->$show;
			} else {
				$display = '(' . $user->user_login . ')';
			}

			$_selected = selected( $user->ID, $parsed_args['selected'], false );
			$output   .= "\t<option value='$user->ID'$_selected>" . esc_html( $display ) . "</option>\n";
		}

		$output .= '</select>';
	}

	/**
	 * Filters the wp_dropdown_users() HTML output.
	 *
	 * @since 2.3.0
	 *
	 * @param string $output HTML output generated by wp_dropdown_users().
	 */
	$html = apply_filters( 'wp_dropdown_users', $output );

	if ( $parsed_args['echo'] ) {
		echo $html;
	}
	return $html;
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘wp_dropdown_users’, string $output ): Filters the wp_dropdown_users() HTML output.
apply_filters( ‘wp_dropdown_users_args’, array $query_args, array $parsed_args ): Filters the query arguments for the list of users in the dropdown.

Uses	Description
selected()`wp-includes/general-template.php`	Outputs the HTML selected attribute.
is_author()`wp-includes/query.php`	Determines whether the query is for an existing author archive page.
get_query_var()`wp-includes/query.php`	Retrieves the value of a query variable in the WP_Query class.
wp_array_slice_assoc()`wp-includes/functions.php`	Extracts a slice of an array, given a list of keys.
get_users()`wp-includes/user.php`	Retrieves list of users matching criteria.
esc_attr()`wp-includes/formatting.php`	Escaping for HTML attributes.
esc_html()`wp-includes/formatting.php`	Escaping for HTML blocks.
get_userdata()`wp-includes/pluggable.php`	Retrieves user info by user ID.
get_current_blog_id()`wp-includes/load.php`	Retrieves the current site ID.
wp_parse_args()`wp-includes/functions.php`	Merges user defined arguments into defaults array.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.

Show 6 more Show less

Used by	Description
post_author_meta_box()`wp-admin/includes/meta-boxes.php`	Displays form field with list of authors.
WP_Posts_List_Table::inline_edit()`wp-admin/includes/class-wp-posts-list-table.php`	Outputs the hidden row displayed when inline editing

Changelog

Version	Description
5.9.0	Added the `'capability'`, `'capability__in'`, and `'capability__not_in'` parameters. Deprecated the `'who'` parameter.
4.7.0	Added the `'role'`, `'role__in'`, and `'role__not_in'` parameters.
4.5.0	Added the `'display_name_with_login'` value for `'show'`.
2.3.0	Introduced.

User Contributed Notes

Skip to note 5 content

Codex 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Dropdown with Submit Button
Displays a users drop-down list in HTML form with a submit button.
```
<li id="users">
	<h2><?php esc_html_e( 'users:' ); ?></h2>
	<form action="<?php home_url(); ?>" method="get">
		<?php wp_dropdown_users( array( 'name' => 'author' ) ); ?>
		<input type="submit" name="submit" value="view" />
	</form>
</li>
```
Log in to add feedback

minimamente 9 years ago

Query users by role (that work):

$query_users_ids_by_role = [
	'fields' =&gt; ['id'],
	'role' =&gt; $role
];

$array_of_users = get_users( $query_users_ids_by_role );

$array_of_users_ids = array_map(function ($user) {
	return $user-&gt;id;
}, $array_of_users);

$users_ids_list = implode( ',', $array_of_users_ids );

$query_for_dropdown = [
	'show_option_all'   =&gt; __('All users'),
	'orderby'           =&gt; 'display_name',
	'order'             =&gt; 'ASC',
	'include'           =&gt; $users_ids_list
];

wp_dropdown_users($query_for_dropdown);

Skip to note 7 content

Stephen 4 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

The ‘who‘ argument is no longer valid since version 5.9, you’ll need to use the new capabilities or role argument:

New Capability Queries in WordPress 5.9

Log in to add feedback

Mike Ritter 10 years ago

-1

Query users by role:

$role = 'subscriber';

$query_users_ids_by_role = array(
	'field' => 'id',
	'role' => $role
);

$array_of_users_ids = get_users( $query_users_ids_by_role );

$users_ids_list = implode( ',',$array_of_users_ids );

$query_for_dropdown = array(
    'include' => $user_ids_list,
);

wp_dropdown_users( $query_for_dropdown );

* Accumulated from others’ work too.

wp_dropdown_users( array|string $args = '' ): string

In this article