wp_xmlrpc_server::wp_getUsers() WordPress Method

	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;
	}
Uses	Description
wp-includes/IXR/class-IXR-error.php:IXR_Error::__construct()	PHP5 constructor.
wp-includes/capabilities.php:current_user_can()	Returns whether the current user has the specified capability.
wp-includes/capabilities.php:get_role()	Retrieves role object.
wp-includes/l10n.php:__()	Retrieve the translation of $text.
wp-includes/functions.php:absint()	Convert a value to non-negative integer.
wp-includes/plugin.php:apply_filters()	Calls the callback functions that have been added to a filter hook.
wp-includes/plugin.php:do_action()	Calls the callback functions that have been added to an action hook.
wp-includes/user.php:get_users()	Retrieves list of users matching criteria.
wp-includes/class-wp-xmlrpc-server.php:xmlrpc_default_user_fields	Filters the default user query fields used by the given XML-RPC method.
wp-includes/class-wp-xmlrpc-server.php:wp_xmlrpc_server::_prepare_user()	Prepares user data for return in an XML-RPC object.
wp-includes/class-wp-xmlrpc-server.php:wp_xmlrpc_server::minimum_args()	Checks if the method received at least the minimum number of arguments.
wp-includes/class-wp-xmlrpc-server.php:xmlrpc_call	Fires after the XML-RPC user has been authenticated but before the rest of the method logic begins.
wp-includes/class-wp-xmlrpc-server.php:wp_xmlrpc_server::escape()	Escape string or array of strings for database.
wp-includes/class-wp-xmlrpc-server.php:wp_xmlrpc_server::login()	Log user in.