wp_list_users( string|array $args = array() ): string|null

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$argsstring|arrayoptional

Array or string of default arguments.Default: array()

• $orderbystringdefault: 'name'

  How 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'.

• $orderstringdefault: 'ASC'

  Sorting direction for $orderby. Accepts 'ASC', 'DESC'.

• $numberintdefault: empty (all users)

  Maximum users to return or display.

• $exclude_adminbooldefault: true

  Whether to exclude the 'admin' account, if it exists.

• $show_fullnamebooldefault: false

  Whether to show the user's full name.

• $feedstringdefault: empty

  If not empty, show a link to the user's feed and use this text as the alt parameter of the link.

• $feed_imagestringdefault: empty

  If not empty, show a link to the user's feed and use this image URL as clickable anchor.

• $feed_typestring

  The feed type to link to, such as 'rss2'. Defaults to default feed type.

• $echobooldefault: true

  Whether to output the result or instead return it.

• $stylestring

  If 'list', each user is wrapped in an <li> element, otherwise the users will be separated by commas.

• $htmlbooldefault: true

  Whether to list the items in HTML form or plaintext.

• $excludestringdefault: empty

  An array, comma-, or space-separated list of user IDs to exclude.

• $includestringdefault: empty

  An array, comma-, or space-separated list of user IDs to include.

Return value

string|null

The output if echo is false. Otherwise null.

Performance profile

How much work a call to wp_list_users() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_users().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

35–37

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 140.

Plugin surface

1 hook

Third-party callbacks on 'wp_list_users_args' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_users()called directly
• optionoption read or writeget_option()one call below wp_list_users()

Further down the call graph this can also reach cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_list_users() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while wp_list_users() runs, in this order:

1. 1
   apply_filters( wp_list_users_args )filterline 945 (+32 into the body)

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

Uses · 9

• wp_parse_args()Merges user defined arguments into defaults array.
• wp_array_slice_assoc()Extracts a slice of an array, given a list of keys.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_users()Retrieves list of users matching criteria.
• get_userdata()Retrieves user info by user ID.
• _x()Retrieves translated string with gettext context.
• get_author_feed_link()Retrieves the feed link for a given author.
• esc_attr()Escaping for HTML attributes.
• esc_url()Checks and cleans a URL.

Source code

View on Trac ↗View on GitHub ↗

913function wp_list_users( $args = array() ) {914	$defaults = array(915		'orderby'       => 'name',916		'order'         => 'ASC',917		'number'        => '',918		'exclude_admin' => true,919		'show_fullname' => false,920		'feed'          => '',921		'feed_image'    => '',922		'feed_type'     => '',923		'echo'          => true,924		'style'         => 'list',925		'html'          => true,926		'exclude'       => '',927		'include'       => '',928	);929 930	$parsed_args = wp_parse_args( $args, $defaults );931 932	$return = '';933 934	$query_args           = wp_array_slice_assoc( $parsed_args, array( 'orderby', 'order', 'number', 'exclude', 'include' ) );935	$query_args['fields'] = 'ids';936 937	/**938	 * Filters the query arguments for the list of all users of the site.939	 *940	 * @since 6.1.0941	 *942	 * @param array $query_args  The query arguments for get_users().943	 * @param array $parsed_args The arguments passed to wp_list_users() combined with the defaults.944	 */945	$query_args = apply_filters( 'wp_list_users_args', $query_args, $parsed_args );946 947	$users = get_users( $query_args );948 949	foreach ( $users as $user_id ) {950		$user = get_userdata( $user_id );951 952		if ( $parsed_args['exclude_admin'] && 'admin' === $user->display_name ) {953			continue;954		}955 956		if ( $parsed_args['show_fullname'] && '' !== $user->first_name && '' !== $user->last_name ) {957			$name = sprintf(958				/* translators: 1: User's first name, 2: Last name. */959				_x( '%1$s %2$s', 'Display name based on first name and last name' ),960				$user->first_name,961				$user->last_name962			);963		} else {964			$name = $user->display_name;965		}966 967		if ( ! $parsed_args['html'] ) {968			$return .= $name . ', ';969 970			continue; // No need to go further to process HTML.971		}972 973		if ( 'list' === $parsed_args['style'] ) {974			$return .= '<li>';975		}976 977		$row = $name;978 979		if ( ! empty( $parsed_args['feed_image'] ) || ! empty( $parsed_args['feed'] ) ) {980			$row .= ' ';981			if ( empty( $parsed_args['feed_image'] ) ) {982				$row .= '(';983			}984 985			$row .= '<a href="' . get_author_feed_link( $user->ID, $parsed_args['feed_type'] ) . '"';986 987			$alt = '';988			if ( ! empty( $parsed_args['feed'] ) ) {989				$alt  = ' alt="' . esc_attr( $parsed_args['feed'] ) . '"';990				$name = $parsed_args['feed'];991			}992

Changelog

Introduced in 5.9.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/user.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.