Filters the query arguments for the list of all users of the site.
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_list_users() combined with the defaults.
More Arguments from wp_list_users( … $args )
Array or string of default arguments.
orderbystringHow to sort the users. Accepts'nicename','email','url','registered','user_nicename','user_email','user_url','user_registered','name','display_name','post_count','ID','meta_value','user_login'. Default'name'.orderstringSorting direction for $orderby. Accepts'ASC','DESC'. Default'ASC'.numberintMaximum users to return or display. Default empty (all users).exclude_adminboolWhether to exclude the'admin'account, if it exists. Default false.show_fullnameboolWhether to show the user’s full name. Default false.feedstringIf not empty, show a link to the user’s feed and use this text as the alt parameter of the link.feed_imagestringIf not empty, show a link to the user’s feed and use this image URL as clickable anchor.feed_typestringThe feed type to link to, such as'rss2'. Defaults to default feed type.echoboolWhether to output the result or instead return it. Default true.stylestringIf'list', each user is wrapped in an<li>element, otherwise the users will be separated by commas.htmlboolWhether to list the items in HTML form or plaintext. Default true.excludestringAn array, comma-, or space-separated list of user IDs to exclude.includestringAn array, comma-, or space-separated list of user IDs to include.
Source
$query_args = apply_filters( 'wp_list_users_args', $query_args, $parsed_args );
Changelog
| Version | Description |
|---|---|
| 6.1.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.