W3cubDocs

/WordPress

wp_xmlrpc_server::wp_getUser( array $args )

Retrieve 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

(array) (Required) Method arguments. Note: arguments must be ordered as documented.

'blog_id'
(int) (unused)
'username'
(string)
'password'
(string)
'user_id'
(int)
'fields'
(array) (optional)

Return

(array|IXR_Error) Array contains (based on $fields parameter):

'user_id'
'username'
'first_name'
'last_name'
'registered'
'bio'
'email'
'nickname'
'nicename'
'url'
'display_name'
'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 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' );
		}

		$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.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 );
	}

Uses

Uses	Description
wp-includes/capabilities.php: current_user_can()	Returns whether the current user has the specified capability.
wp-includes/l10n.php: __()	Retrieve the translation of $text.
wp-includes/pluggable.php: get_userdata()	Retrieve user info by user ID.
wp-includes/plugin.php: apply_filters()	Calls the callback functions that have been added to a filter hook.
wp-includes/plugin.php: do_action()	Execute functions hooked on a specific action hook.
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.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_xmlrpc_server/wp_getuser