wp_dropdown_users_args – Hook | Developer.WordPress.org

Filters the query arguments for the list of users in the dropdown.

Parameters

$query_argsarray

The query arguments for get_users() .

More Arguments from get_users( … $args )

Arguments to retrieve users. See WP_User_Query::prepare_query() for more information on accepted arguments.

$parsed_argsarray

The arguments passed to wp_dropdown_users() combined with the defaults.

More Arguments from wp_dropdown_users( … $args )

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.

Source

$query_args = apply_filters( 'wp_dropdown_users_args', $query_args, $parsed_args );

View all references View on Trac View on GitHub

Used by	Description
wp_dropdown_users()`wp-includes/user.php`	Creates dropdown HTML content of users.

Changelog

Version	Description
4.4.0	Introduced.

User Contributed Notes

Skip to note 6 content

Jonathan Goldford 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note
This filter allows you to set subscribers as authors of blog posts within the admin without giving them additional privileges. Here’s the code:
```
add_filter( 'wp_dropdown_users_args', 'wpdocs_add_subscribers_to_dropdown' );
function wpdocs_add_subscribers_to_dropdown( $query_args ) {

    $query_args['who'] = '';
    return $query_args;

}
```
- I’ve been using this for a while and it was working well for both filtering by Author and Batch Editing post and assigning them to subscribers. However batch editing now only shows Admin users.
  
  edouardflowasia 3 years ago
- It seems like this code is not displaying subscribers in the dropdown anymore.
  
  Kich 2 years ago
Log in to add feedback
Skip to note 7 content

RiseOfLex88 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note
In addition to Jonathan’s contribution, you can also expand it further by specifying the role. This is undocumented on wp codex. But does work e.g.
```
function wpdocs_add_subscribers_to_dropdown( $query_args, $r ) {
 
	$query_args['role'] = array('contributor');

	// Unset the 'who' as this defaults to the 'author' role
	unset( $query_args['who'] );

	return $query_args;
}
add_filter( 'wp_dropdown_users_args', 'wpdocs_add_subscribers_to_dropdown', 10, 2 );
```
Log in to add feedback

pgDarkness 5 years ago

In addition to RiseOfLex88’s contribution, you can also specify multiple roles.

function wpdocs_add_subscribers_to_dropdown( $query_args ) {

	// Use this array to specify multiple roles to show in dropdown
    $query_args['role__in'] = array( 'contributor', 'administrator' );

	// Use this array to specify multiple roles to hide in dropdown
    $query_args['role__not_in'] = array( 'editor' );

    // Unset the 'who' as this defaults to the 'author' role
    unset( $query_args['who'] );
 
    return $query_args;
}
add_filter( 'wp_dropdown_users_args', 'wpdocs_add_subscribers_to_dropdown' );

If you dump variable “$query_args” inside this function, this is what you will get:

array(10) { 
  ["blog_id"]=&gt; int(1) 
  ["include"]=&gt; string(0) "" 
  ["exclude"]=&gt; string(0) "" 
  ["orderby"]=&gt; string(12) "display_name" 
  ["order"]=&gt; string(3) "ASC" 
  ["who"]=&gt; string(7) "authors" 
  ["role"]=&gt; string(0) "" 
  ["role__in"]=&gt; array(0) { } 
  ["role__not_in"]=&gt; array(0) { } 
  ["fields"]=&gt; array(3) { 
    [0]=&gt; string(2) "ID" 
    [1]=&gt; string(10) "user_login" 
    [2]=&gt; string(12) "display_name" 
  } 
}

Skip to note 9 content

Sarah Lewis 2 years ago

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

Note that if you’re trying to filter the “Author” dropdown on the post editor screen, and the post editor is using Gutenberg, this filter doesn’t fire. You’ll need to work with the rest_user_query filter instead. (But also note that this filter is used for a lot more than the Author dropdown, so use it thoughtfully.)

Log in to add feedback

JamesKoussertari 1 year ago

For this to work with Subscribers, you’ll also need to adjust the capability:

// Show Subscribers in the 'author' drop down on the classic post editor
function wpdocs_add_subscribers_to_dropdown( $query_args ) {
    $query_args['who'] = ''; // reset the query
    $query_args['capability'] = ''; // reset the query
    $query_args['role__in'] = array( 'administrator', 'subscriber', 'author', 'editor' );
    $query_args['capability__in'] = array( 'edit_own_posts' ); // Custom capability for subscribers

    return $query_args;
}
add_filter( 'wp_dropdown_users_args', 'wpdocs_add_subscribers_to_dropdown' );

apply_filters( ‘wp_dropdown_users_args’, array $query_args, array $parsed_args )

In this article

Parameters

Source

Changelog

User Contributed Notes

apply_filters( ‘wp_dropdown_users_args’, array $query_args, array $parsed_args )

In this article

Parameters

Source

Related

Changelog

User Contributed Notes