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

Retrieve information about the requesting user.


Parameters

$args array Required
Method arguments. Note: arguments must be ordered as documented.
  • blog_idint
    (unused)
  • usernamestring
  • passwordstring
  • fieldsarray
    (optional)

Top ↑

Return

array|IXR_Error (@see wp_getUser)


Top ↑

Source

File: wp-includes/class-wp-xmlrpc-server.php. View all references

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', $args, $this );

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

Top ↑

Hooks



Top ↑

User Contributed Notes

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