Filters the query arguments for the list of all authors of the site.

$query_args array

The query arguments for get_users() .

More Arguments from get_users( ... $args )

Array or string of Query parameters.

• blog_idint
  The site ID. Default is the current site.
• rolestring|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__instring[]
  An array of role names. Matched users must have at least one of these roles.
• role__not_instring[]
  An array of role names to exclude. Users matching one or more of these roles will not be included in results.
• meta_keystring|string[]
  Meta key or keys to filter by.
• meta_valuestring|string[]
  Meta value or values to filter by.
• meta_comparestring
  MySQL operator used for comparing the meta value.
  See WP_Meta_Query::__construct() for accepted values and default value.
• meta_compare_keystring
  MySQL operator used for comparing the meta key.
  See WP_Meta_Query::__construct() for accepted values and default value.
• meta_typestring
  MySQL 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_keystring
  MySQL 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_queryarray
  An associative array of WP_Meta_Query arguments.
  See WP_Meta_Query::__construct() for accepted values.
• capabilitystring|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__instring[]
  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_instring[]
  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'.
  
• includeint[]
  An array of user IDs to include.
• excludeint[]
  An array of user IDs to exclude.
• searchstring
  Search 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_columnsstring[]
  Array of column names to be searched. Accepts 'ID', 'user_login', 'user_email', 'user_url', 'user_nicename', 'display_name'.
  
• orderbystring|array
  Field(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'.
• orderstring
  Designates 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'.
• offsetint
  Number of users to offset in retrieved results. Can be used in conjunction with pagination. Default 0.
• numberint
  Number 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).
• pagedint
  When used with number, defines the page of results to return.
  Default 1.
• count_totalbool
  Whether to count the total number of users found. If pagination is not needed, setting this to false can improve performance.
  Default true.
• fieldsstring|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'.

  Default 'all'.
• whostring
  Type of users to query. Accepts 'authors'.
  Default empty (all users).
• has_published_postsbool|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.
• nicenamestring
  The user nicename.
• nicename__instring[]
  An array of nicenames to include. Users matching one of these nicenames will be included in results.
• nicename__not_instring[]
  An array of nicenames to exclude. Users matching one of these nicenames will not be included in results.
• loginstring
  The user login.
• login__instring[]
  An array of logins to include. Users matching one of these logins will be included in results.
• login__not_instring[]
  An array of logins to exclude. Users matching one of these logins will not be included in results.

$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.

• orderbystring
  How 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'.
• orderstring
  Sorting direction for $orderby. Accepts 'ASC', 'DESC'. Default 'ASC'.
• numberint
  Maximum authors to return or display. Default empty (all authors).
• optioncountbool
  Show the count in parenthesis next to the author's name. Default false.
• exclude_adminbool
  Whether to exclude the 'admin' account, if it exists. Default true.
• show_fullnamebool
  Whether to show the author's full name. Default false.
• hide_emptybool
  Whether to hide any authors with no posts. Default true.
• feedstring
  If not empty, show a link to the author's feed and use this text as the alt parameter of the link.
• feed_imagestring
  If not empty, show a link to the author's feed and use this image URL as clickable anchor.
• feed_typestring
  The feed type to link to. Possible values include 'rss2', 'atom'.
  Default is the value of get_default_feed() .
• echobool
  Whether to output the result or instead return it. Default true.
• stylestring
  If 'list', each author is wrapped in an <li> element, otherwise the authors will be separated by commas.
• htmlbool
  Whether to list the items in HTML form or plaintext. Default true.
• excludeint[]|string
  Array or comma/space-separated list of author IDs to exclude.
• includeint[]|string
  Array or comma/space-separated list of author IDs to include.

File: wp-includes/author-template.php. View all references

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