wp_xmlrpc_server::wp_getUser( array $args )
Retrieves a user.
Description
The optional $fields parameter specifies what fields will be included in the response array. This should be a list of field names. ‘user_id’ will always be included in the response regardless of the value of $fields.
Instead of, or in addition to, individual field names, conceptual group names can be used to specify multiple fields. The available conceptual groups are ‘basic’ and ‘all’.
Parameters
- $args
-
(Required) Method arguments. Note: arguments must be ordered as documented.<br>
- (int) Blog ID (unused).<br>
- '1'
(string) Username.<br> - '2'
(string) Password.<br> - '3'
(int) User ID.<br> - '4'
(array) Optional. Array of fields to return.<br>
Return
(array|IXR_Error) Array contains (based on $fields parameter):<br>
- 'user_id'<br>
- 'username'<br>
- 'first_name'<br>
- 'last_name'<br>
- 'registered'<br>
- 'bio'<br>
- 'email'<br>
- 'nickname'<br>
- 'nicename'<br>
- 'url'<br>
- 'display_name'<br>
- 'roles'
Source
File: wp-includes/class-wp-xmlrpc-server.php
public function wp_getUser( $args ) {
if ( ! $this->minimum_args( $args, 4 ) )
return $this->error;
$this->escape( $args );
$username = $args[1];
$password = $args[2];
$user_id = (int) $args[3];
if ( isset( $args[4] ) ) {
$fields = $args[4];
} else {
/**
* Filters the default user query fields used by the given XML-RPC method.
*
* @since WP-3.5.0
*
* @param array $fields User query fields for given method. Default 'all'.
* @param string $method The method name.
*/
$fields = apply_filters( 'xmlrpc_default_user_fields', array( 'all' ), 'wp.getUser' );
}
if ( ! $user = $this->login( $username, $password ) )
return $this->error;
/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
do_action( 'xmlrpc_call', 'wp.getUser' );
if ( ! current_user_can( 'edit_user', $user_id ) )
return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this user.' ) );
$user_data = get_userdata( $user_id );
if ( ! $user_data )
return new IXR_Error( 404, __( 'Invalid user ID.' ) );
return $this->_prepare_user( $user_data, $fields );
}