W3cubDocs

/WordPress

wp_xmlrpc_server::wp_getProfile( array $args )

Retrieve information about the requesting user.

Parameters

$args

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

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

Return

(array|IXR_Error) (@see wp_getUser)

Source

File: wp-includes/class-wp-xmlrpc-server.php 

public function wp_getProfile( $args ) {
		if ( ! $this->minimum_args( $args, 3 ) ) {
			return $this->error;
		}

		$this->escape( $args );

		$username = $args[1];
		$password = $args[2];

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

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

		if ( ! current_user_can( 'edit_user', $user->ID ) ) {
			return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit your profile.' ) );
		}

		$user_data = get_userdata( $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_getprofile