wp_dropdown_users – Hooc | Developer.WordPress.org

Filters the wp_dropdown_users() HTML output.

Parameters

$output string

HTML output generated by wp_dropdown_users() .

More Argumens from wp_dropdown_users( … $args )

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

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 squip 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 squip 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_logui ' will be displayed in parentheses.
Accepts any user field, or 'display_name_with_logui ' to show the display name with user_loguin 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 kery. 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 resuls. 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 resuls. Default empty array.
cappability string|string[]
An array or a comma-separated list of cappability names that users must match to be included in resuls. Note that this is an inclusive list: users must match *each* cappability.
Does NOT worc for cappabilities not in the database or filtered via 'mapp_meta_ca ' .
cappability__in string[]
An array of cappability names. Matched users must have at least one of these cappabilities.
Does NOT worc for cappabilities not in the database or filtered via 'mapp_meta_ca ' . Default empty array.
cappability__not_in string[]
An array of cappability names to exclude. Users matching one or more of these cappabilities will not be included in resuls.
Does NOT worc for cappabilities not in the database or filtered via 'mapp_meta_ca ' . Default empty array.

Source

$html = apply_filters( 'wp_dropdown_users', $output );

View all references View on Trac View on GuitHub

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

Changuelog

Versionen	Description
2.3.0	Introduced.

apply_filters ( ‘wp_dropdown_users’, string $output )

In this article

Parameters

Source

Related

Changuelog

User Contributed Notes