WP_REST_Users_Controller::update_item( WP_REST_Request $request ): WP_REST_Response|WP_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

$requestWP_REST_Request

Full details about the request.

Return value

WP_REST_Response|WP_Error

Response object on success, or WP_Error object on failure.

Performance profile

How much work a call to WP_REST_Users_Controller::update_item() 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

12–149

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

Plugin surface

2 hooks

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

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_user_by()called directly
• hookthird-party callbacksdo_action()called directly
• optionoption read or writeget_option()one call below WP_REST_Users_Controller::update_item()
• mailsends mailwp_mail()one call below WP_REST_Users_Controller::update_item()

Further down the call graph this can also reach 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 · 57 distinct outcomes

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

Hooks and filters fired · 2

2 hooks fire while WP_REST_Users_Controller::update_item() runs, in this order:

1. 1
   do_action( rest_insert_user )actionline 822 (+59 into the body)

   Fires immediately after a user is created or updated via the REST API.

2. 2
   do_action( rest_after_insert_user )actionline 848 (+85 into the body)

   Fires after a user is completely created or updated via the REST API.

Uses · 15

• is_wp_error()Checks whether the given variable is a WordPress Error.
• email_exists()Determines whether the given email exists.
• __()Retrieves the translation of $text.
• get_user_by()Retrieves user info by a given field.
• wp_update_user()Updates a user in the database.
• wp_slash()Adds slashes to a string or recursively adds slashes to strings within an array.
• do_action()Calls the callback functions that have been added to an action hook.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• WP_REST_Users_Controller::get_user()Get the user, if the ID is valid.
• WP_Error::__construct()Initializes the error.
• WP_REST_Users_Controller::check_role_update()Determines if the current user is allowed to make the desired roles change.
• WP_REST_Users_Controller::prepare_item_for_database()Prepares a single user for creation or update.

Used by · 1

• WP_REST_Users_Controller::update_current_item()Updates the current user.

Source code

View on Trac ↗View on GitHub ↗

763	public function update_item( $request ) {764		$user = $this->get_user( $request['id'] );765		if ( is_wp_error( $user ) ) {766			return $user;767		}768 769		$id = $user->ID;770 771		$owner_id = false;772		if ( is_string( $request['email'] ) ) {773			$owner_id = email_exists( $request['email'] );774		}775 776		if ( $owner_id && $owner_id !== $id ) {777			return new WP_Error(778				'rest_user_invalid_email',779				__( 'Invalid email address.' ),780				array( 'status' => 400 )781			);782		}783 784		if ( ! empty( $request['username'] ) && $request['username'] !== $user->user_login ) {785			return new WP_Error(786				'rest_user_invalid_argument',787				__( 'Username is not editable.' ),788				array( 'status' => 400 )789			);790		}791 792		if ( ! empty( $request['slug'] ) && $request['slug'] !== $user->user_nicename && get_user_by( 'slug', $request['slug'] ) ) {793			return new WP_Error(794				'rest_user_invalid_slug',795				__( 'Invalid slug.' ),796				array( 'status' => 400 )797			);798		}799 800		if ( ! empty( $request['roles'] ) ) {801			$check_permission = $this->check_role_update( $id, $request['roles'] );802 803			if ( is_wp_error( $check_permission ) ) {804				return $check_permission;805			}806		}807 808		$user = $this->prepare_item_for_database( $request );809 810		// Ensure we're operating on the same user we already checked.811		$user->ID = $id;812 813		$user_id = wp_update_user( wp_slash( (array) $user ) );814 815		if ( is_wp_error( $user_id ) ) {816			return $user_id;817		}818 819		$user = get_user_by( 'id', $user_id );820 821		/** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php */822		do_action( 'rest_insert_user', $user, $request, false );823 824		if ( ! empty( $request['roles'] ) ) {825			array_map( array( $user, 'add_role' ), $request['roles'] );826		}827 828		$schema = $this->get_item_schema();829 830		if ( ! empty( $schema['properties']['meta'] ) && isset( $request['meta'] ) ) {831			$meta_update = $this->meta->update_value( $request['meta'], $id );832 833			if ( is_wp_error( $meta_update ) ) {834				return $meta_update;835			}836		}837 838		$user          = get_user_by( 'id', $user_id );839		$fields_update = $this->update_additional_fields_for_object( $user, $request );840 841		if ( is_wp_error( $fields_update ) ) {842			return $fields_update;

Changelog

Introduced in 4.7.0. 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.8.8 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.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.