apply_filters( 'wp_list_authors_args', array $query_args , array $parsed_args )
Filters the query arguments for the list of all authors of the site.
Parameters
-
$query_args
array -
The query arguments for get_users() .
More Arguments from get_users( ... $args )
Array or string of query parameters.
blog_id
intThe site ID. Default is the current site.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.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.meta_key
string|string[]Meta key or keys to filter by.meta_value
string|string[]Meta value or values to filter by.meta_compare
stringMySQL operator used for comparing the meta value.
See WP_Meta_Query::__construct() for accepted values and default value.meta_compare_key
stringMySQL operator used for comparing the meta key.
See WP_Meta_Query::__construct() for accepted values and default value.meta_type
stringMySQL data type that the meta_value column will be CAST to for comparisons.
See WP_Meta_Query::__construct() for accepted values and default value.meta_type_key
stringMySQL data type that the meta_key column will be CAST to for comparisons.
See WP_Meta_Query::__construct() for accepted values and default value.meta_query
arrayAn associative array of WP_Meta_Query arguments.
See WP_Meta_Query::__construct() for accepted values.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'.
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'.
include
int[]An array of user IDs to include.exclude
int[]An array of user IDs to exclude.search
stringSearch keyword. Searches for possible string matches on columns.
When$search_columns
is left empty, it tries to determine which column to search in based on search string.search_columns
string[]Array of column names to be searched. Accepts'ID'
,'user_login'
,'user_email'
,'user_url'
,'user_nicename'
,'display_name'
.
orderby
string|arrayField(s) to sort the retrieved users by. May be a single value, an array of values, or a multi-dimensional array with fields as keys and orders ('ASC'
or'DESC'
) as values. Accepted values are:
'ID'
'display_name'
(or'name'
)'include'
'user_login'
(or'login'
)'login__in'
'user_nicename'
(or'nicename'
),'nicename__in'
- 'user_email (or
'email'
) 'user_url'
(or'url'
),'user_registered'
(or'registered'
)'post_count'
'meta_value'
,'meta_value_num'
- The value of
$meta_key
- An array key of
$meta_query
To use'meta_value'
or'meta_value_num'
,$meta_key
must be also be defined. Default'user_login'
.
order
stringDesignates ascending or descending order of users. Order values passed as part of an$orderby
array take precedence over this parameter. Accepts'ASC'
,'DESC'
. Default'ASC'
.offset
intNumber of users to offset in retrieved results. Can be used in conjunction with pagination. Default 0.number
intNumber of users to limit the query for. Can be used in conjunction with pagination. Value -1 (all) is supported, but should be used with caution on larger sites.
Default -1 (all users).paged
intWhen used with number, defines the page of results to return.
Default 1.count_total
boolWhether to count the total number of users found. If pagination is not needed, setting this to false can improve performance.
Default true.fields
string|string[]Which fields to return. Single or all fields (string), or array of fields. Accepts:
'ID'
'display_name'
'user_login'
'user_nicename'
'user_email'
'user_url'
'user_registered'
'user_pass'
'user_activation_key'
'user_status'
'spam'
(only available on multisite installs)'deleted'
(only available on multisite installs)'all'
for all fields and loads user meta.'all_with_meta'
Deprecated. Use'all'
.
'all'
.who
stringType of users to query. Accepts'authors'
.
Default empty (all users).has_published_posts
bool|string[]Pass an array of post types to filter results to users who have published posts in those post types.true
is an alias for all public post types.nicename
stringThe user nicename.nicename__in
string[]An array of nicenames to include. Users matching one of these nicenames will be included in results.nicename__not_in
string[]An array of nicenames to exclude. Users matching one of these nicenames will not be included in results.login
stringThe user login.login__in
string[]An array of logins to include. Users matching one of these logins will be included in results.login__not_in
string[]An array of logins to exclude. Users matching one of these logins will not be included in results.cache_results
boolWhether to cache user information. Default true.
-
$parsed_args
array -
The arguments passed to wp_list_authors() combined with the defaults.
More Arguments from wp_list_authors( ... $args )
Array or string of default arguments.
orderby
stringHow to sort the authors. 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'
.order
stringSorting direction for $orderby. Accepts'ASC'
,'DESC'
. Default'ASC'
.number
intMaximum authors to return or display. Default empty (all authors).optioncount
boolShow the count in parenthesis next to the author's name. Default false.exclude_admin
boolWhether to exclude the'admin'
account, if it exists. Default true.show_fullname
boolWhether to show the author's full name. Default false.hide_empty
boolWhether to hide any authors with no posts. Default true.feed
stringIf not empty, show a link to the author's feed and use this text as the alt parameter of the link.feed_image
stringIf not empty, show a link to the author's feed and use this image URL as clickable anchor.feed_type
stringThe feed type to link to. Possible values include'rss2'
,'atom'
.
Default is the value of get_default_feed() .echo
boolWhether to output the result or instead return it. Default true.style
stringIf'list'
, each author is wrapped in an<li>
element, otherwise the authors will be separated by commas.html
boolWhether to list the items in HTML form or plaintext. Default true.exclude
int[]|stringArray or comma/space-separated list of author IDs to exclude.include
int[]|stringArray or comma/space-separated list of author IDs to include.
Source
File: wp-includes/author-template.php
.
View all references
$query_args = apply_filters( 'wp_list_authors_args', $query_args, $parsed_args );
Changelog
Version | Description |
---|---|
6.1.0 | Introduced. |