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

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$argsarray

Method arguments. Note: arguments must be ordered as documented.

• $0int

  Blog ID (unused).

• $1string

  Username.

• $2string

  Password.

• $3array

  Content struct. It can optionally contain:

  • 'first_name'
  • 'last_name'
  • 'website'
  • 'display_name'
  • 'nickname'
  • 'nicename'
  • 'bio'

Return value

true|IXR_Error

True, on success.

Performance profile

How much work a call to wp_xmlrpc_server::wp_editProfile() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Expensive

Sends mail via wp_mail().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

8–88

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 108.

Plugin surface

1 hook

Third-party callbacks on 'xmlrpc_call' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksdo_action()called directly
• optionoption read or writeget_option()one call below wp_xmlrpc_server::wp_editProfile()
• mailsends mailwp_mail()one call below wp_xmlrpc_server::wp_editProfile()

Further down the call graph this can also reach query, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 6 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_xmlrpc_server::wp_editProfile() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while wp_xmlrpc_server::wp_editProfile() runs, in this order:

1. 1
   do_action( xmlrpc_call )actionline 2901 (+17 into the body)

   Fires after the XML-RPC user has been authenticated but before the rest of the method logic begins.

Uses · 9

• do_action()Calls the callback functions that have been added to an action hook.
• current_user_can()Returns whether the current user has the specified capability.
• __()Retrieves the translation of $text.
• wp_update_user()Updates a user in the database.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_xmlrpc_server::minimum_args()Checks if the method received at least the minimum number of arguments.
• wp_xmlrpc_server::escape()Escapes string or array of strings for database.
• wp_xmlrpc_server::login()Logs user in.
• IXR_Error::__construct()PHP5 constructor.

Source code

View on Trac ↗View on GitHub ↗

2884	public function wp_editProfile( $args ) {2885		if ( ! $this->minimum_args( $args, 4 ) ) {2886			return $this->error;2887		}2888 2889		$this->escape( $args );2890 2891		$username       = $args[1];2892		$password       = $args[2];2893		$content_struct = $args[3];2894 2895		$user = $this->login( $username, $password );2896		if ( ! $user ) {2897			return $this->error;2898		}2899 2900		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */2901		do_action( 'xmlrpc_call', 'wp.editProfile', $args, $this );2902 2903		if ( ! current_user_can( 'edit_user', $user->ID ) ) {2904			return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit your profile.' ) );2905		}2906 2907		// Holds data of the user.2908		$user_data       = array();2909		$user_data['ID'] = $user->ID;2910 2911		// Only set the user details if they were given.2912		if ( isset( $content_struct['first_name'] ) ) {2913			$user_data['first_name'] = $content_struct['first_name'];2914		}2915 2916		if ( isset( $content_struct['last_name'] ) ) {2917			$user_data['last_name'] = $content_struct['last_name'];2918		}2919 2920		if ( isset( $content_struct['url'] ) ) {2921			$user_data['user_url'] = $content_struct['url'];2922		}2923 2924		if ( isset( $content_struct['display_name'] ) ) {2925			$user_data['display_name'] = $content_struct['display_name'];2926		}2927 2928		if ( isset( $content_struct['nickname'] ) ) {2929			$user_data['nickname'] = $content_struct['nickname'];2930		}2931 2932		if ( isset( $content_struct['nicename'] ) ) {2933			$user_data['user_nicename'] = $content_struct['nicename'];2934		}2935 2936		if ( isset( $content_struct['bio'] ) ) {2937			$user_data['description'] = $content_struct['bio'];2938		}2939 2940		$result = wp_update_user( $user_data );2941 2942		if ( is_wp_error( $result ) ) {2943			return new IXR_Error( 500, $result->get_error_message() );2944		}2945 2946		if ( ! $result ) {2947			return new IXR_Error( 500, __( 'Sorry, the user could not be updated.' ) );2948		}2949 2950		return true;2951	}

Changelog

Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/class-wp-xmlrpc-server.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.