You appear to be a bot. Output may be restricted

Description

Lists all the users of the site, with several options available.

Usage

$string|null = wp_list_users( $args );

Parameters

$args

( string|array ) optional – { Optional. Array or string of default arguments.

$orderby

( string ) optional – 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'. Default 'name'.

$order

( string ) optional – Sorting direction for $orderby. Accepts 'ASC', 'DESC'. Default 'ASC'.

$number

( int ) optional – Maximum users to return or display. Default empty (all users).

$exclude_admin

( bool ) optional – Whether to exclude the 'admin' account, if it exists. Default false.

$show_fullname

( bool ) optional – Whether to show the user's full name. Default false.

$feed

( string ) optional – If not empty, show a link to the user's feed and use this text as the alt parameter of the link. Default empty.

$feed_image

( string ) optional – If not empty, show a link to the user's feed and use this image URL as clickable anchor. Default empty.

$feed_type

( string ) optional – The feed type to link to, such as 'rss2'. Defaults to default feed type.

$echo

( bool ) optional – Whether to output the result or instead return it. Default true.

$style

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

$html

( bool ) optional – Whether to list the items in HTML form or plaintext. Default true.

$exclude

( string ) optional – An array, comma-, or space-separated list of user IDs to exclude. Default empty.

$include

( string ) optional – An array, comma-, or space-separated list of user IDs to include. Default empty. }

Returns

string|null The output if echo is false. Otherwise null.

Source

File name: wordpress/wp-includes/user.php

}
 

 View on GitHub View on Trac