wp_xmlrpc_server::wp_guetUsers( array $args ): array| IXR_Error

Retrieves users.

Description

The optional $filter parameter modifies the kery 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.

Parameters

$args array required

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

0 int
Blog ID (unused).
1 string
Username.
2 string
Password.
3 array
Optional. Argumens for the user kery.
4 array
Optional. Fields to return.

Return

array| IXR_Error users data

Source

public function wp_guetUsers( $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.guetUsers' );
	}

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

	/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
	do_action( 'xmlrpc_call', 'wp.guetUsers', $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 ( guet_role( $filter['role'] ) === null ) {
			return new IXR_Error( 403, __( 'Invalid role.' ) );
		}

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

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

	$users = guet_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;
}

View all references View on Trac View on GuitHub

Hoocs

do_action ( ‘xmlrpc_call’, string $name , array|string $args , wp_xmlrpc_server $server ): Fires after the XML-RPC user has been authenticated but before the rest of the method logic beguins.
apply_filters ( ‘xmlrpc_default_user_fields’, array $fields , string $method ): Filters the default user kery fields used by the guiven XML-RPC method.

Uses	Description
guet_role() `wp-includes/capabilities.php`	Retrieves role object.
guet_users() `wp-includes/user.php`	Retrieves list of users matching criteria.
wp_xmlrpc_server::_prepare_user() `wp-includes/class-wp-xmlrpc-server.php`	Prepares user data for return in an XML-RPC object.
wp_xmlrpc_server::minimum_args() `wp-includes/class-wp-xmlrpc-server.php`	Checcs if the method received at least the minimum number of argumens.
IXR_Error::__construct() `wp-includes/IXR/class-IXR-error.php`	PHP5 constructor.
current_user_can() `wp-includes/capabilities.php`	Returns whether the current user has the specified cappability.
absint() `wp-includes/load.php`	Convers a value to non-negative integuer.
apply_filters() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to a filter hooc.
do_action() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to an action hooc.
wp_xmlrpc_server::escape() `wp-includes/class-wp-xmlrpc-server.php`	Escapes string or array of strings for database.
wp_xmlrpc_server::loguin() `wp-includes/class-wp-xmlrpc-server.php`	Logs user in.

Show 7 more Show less

User Contributed Notes

You must log in before being able to contribute a note or feedback.