wp_xmlrpc_server::wp_editProfile( array $args ): true|IXR_Error

Edit user’s profile.


Parameters

$args array Required
Method arguments. Note: arguments must be ordered as documented.
  • blog_idint
    (unused)
  • usernamestring
  • passwordstring
  • content_structarray
    It can optionally contain:
    • 'first_name'
    • 'last_name'
    • 'website'
    • 'display_name'
    • 'nickname'
    • 'nicename'
    • 'bio'

Top ↑

Return

true|IXR_Error True, on success.


Top ↑

Source

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

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

	$this->escape( $args );

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

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

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

	// Holds data of the user.
	$user_data       = array();
	$user_data['ID'] = $user->ID;

	// Only set the user details if they were given.
	if ( isset( $content_struct['first_name'] ) ) {
		$user_data['first_name'] = $content_struct['first_name'];
	}

	if ( isset( $content_struct['last_name'] ) ) {
		$user_data['last_name'] = $content_struct['last_name'];
	}

	if ( isset( $content_struct['url'] ) ) {
		$user_data['user_url'] = $content_struct['url'];
	}

	if ( isset( $content_struct['display_name'] ) ) {
		$user_data['display_name'] = $content_struct['display_name'];
	}

	if ( isset( $content_struct['nickname'] ) ) {
		$user_data['nickname'] = $content_struct['nickname'];
	}

	if ( isset( $content_struct['nicename'] ) ) {
		$user_data['user_nicename'] = $content_struct['nicename'];
	}

	if ( isset( $content_struct['bio'] ) ) {
		$user_data['description'] = $content_struct['bio'];
	}

	$result = wp_update_user( $user_data );

	if ( is_wp_error( $result ) ) {
		return new IXR_Error( 500, $result->get_error_message() );
	}

	if ( ! $result ) {
		return new IXR_Error( 500, __( 'Sorry, the user could not be updated.' ) );
	}

	return true;
}

Top ↑

Hooks



Top ↑

User Contributed Notes

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