wp_xmlrpc_server::wp_getUsers() public WP 1.0

Retrieve users.

The optional $filter parameter modifies the query used to retrieve users. Accepted keys are 'number' (default: 50), 'offset' (default: 0), 'role', 'who', 'orderby', and 'order'.

The optional $fields parameter specifies what fields will be included in the response array.

{} It's a method of the class: wp_xmlrpc_server{}

Return

Array|IXR_Error. users data

Usage

$wp_xmlrpc_server = new wp_xmlrpc_server();
$wp_xmlrpc_server->wp_getUsers( $args );

$args(array) (required)

Method arguments. Note: arguments must be ordered as documented.

• blog_id(int)
  (unused)

• username(string)

• password(string)

• filter(array)
  (optional)

• fields(array)
  (optional)

Notes

• See: wp_getUser() for more on $fields and return values

Code of wp_xmlrpc_server::wp_getUsers() wp xmlrpc server::wp getUsers ^{WP 5.7.1}

<?php
public function wp_getUsers( $args ) {
	if ( ! $this->minimum_args( $args, 3 ) ) {
		return $this->error;
	}

	$this->escape( $args );

	$username = $args[1];
	$password = $args[2];
	$filter   = isset( $args[3] ) ? $args[3] : array();

	if ( isset( $args[4] ) ) {
		$fields = $args[4];
	} else {
		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
		$fields = apply_filters( 'xmlrpc_default_user_fields', array( 'all' ), 'wp.getUsers' );
	}

	$user = $this->login( $username, $password );
	if ( ! $user ) {
		return $this->error;
	}

	/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
	do_action( 'xmlrpc_call', 'wp.getUsers', $args, $this );

	if ( ! current_user_can( 'list_users' ) ) {
		return new IXR_Error( 401, __( 'Sorry, you are not allowed to list users.' ) );
	}

	$query = array( 'fields' => 'all_with_meta' );

	$query['number'] = ( isset( $filter['number'] ) ) ? absint( $filter['number'] ) : 50;
	$query['offset'] = ( isset( $filter['offset'] ) ) ? absint( $filter['offset'] ) : 0;

	if ( isset( $filter['orderby'] ) ) {
		$query['orderby'] = $filter['orderby'];

		if ( isset( $filter['order'] ) ) {
			$query['order'] = $filter['order'];
		}
	}

	if ( isset( $filter['role'] ) ) {
		if ( get_role( $filter['role'] ) === null ) {
			return new IXR_Error( 403, __( 'Invalid role.' ) );
		}

		$query['role'] = $filter['role'];
	}

	if ( isset( $filter['who'] ) ) {
		$query['who'] = $filter['who'];
	}

	$users = get_users( $query );

	$_users = array();
	foreach ( $users as $user_data ) {
		if ( current_user_can( 'edit_user', $user_data->ID ) ) {
			$_users[] = $this->_prepare_user( $user_data, $fields );
		}
	}
	return $_users;
}