Retrieves list of users matching criteria.

Description

See also

• WP_User_Query

Parameters

$argsarrayoptional

Arguments to retrieve users. See WP_User_Query::prepare_query() for more information on accepted arguments.

Default:array()

Return

More Information

Return value is an array of IDs, stdClass objects, or WP_User objects, depending on the value of the ‘fields‘ parameter.

• If ‘fields‘ is set to ‘all’ (default), or ‘all_with_meta’, it will return an array of WP_User objects.
• If ‘fields‘ is set to an array of wp_users table fields, it will return an array of stdClass objects with only those fields.
• If ‘fields‘ is set to any individual wp_users table field, an array of IDs will be returned.

Source

function get_users( $args = array() ) {

	$args                = wp_parse_args( $args );
	$args['count_total'] = false;

	$user_search = new WP_User_Query( $args );

	return (array) $user_search->get_results();
}

View all references View on Trac View on GitHub

Changelog