WP_REST_Users_Controller::create_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::create_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

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

12–186

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

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

0

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

What it touches

• querycontent queryget_user_by()called directly
• hookthird-party callbacksdo_action()called directly
• optionnetwork optionget_site_option()one call below WP_REST_Users_Controller::create_item()
• mailsends mailwp_mail()one call below WP_REST_Users_Controller::create_item()
• cacheobject cachewp_cache_delete()one call below WP_REST_Users_Controller::create_item()

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

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Users_Controller::create_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::create_item() runs, in this order:

1. 1
   do_action( rest_insert_user )actionline 668 (+87 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 700 (+119 into the body)

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

Uses · 20

• __()Retrieves the translation of $text.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• is_multisite()Determines whether Multisite is enabled.
• wpmu_validate_user_signup()Sanitizes and validates data required for a user sign-up.
• wpmu_create_user()Creates a user.
• 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.
• add_user_to_blog()Adds a user to a blog, along with specifying the user's role.
• get_site()Retrieves site data given a site ID or site object.
• wp_insert_user()Inserts a user into the database.
• get_user_by()Retrieves user info by a given field.
• do_action()Calls the callback functions that have been added to an action hook.

Source code

View on Trac ↗View on GitHub ↗

581	public function create_item( $request ) {582		if ( ! empty( $request['id'] ) ) {583			return new WP_Error(584				'rest_user_exists',585				__( 'Cannot create existing user.' ),586				array( 'status' => 400 )587			);588		}589 590		$schema = $this->get_item_schema();591 592		if ( ! empty( $request['roles'] ) && ! empty( $schema['properties']['roles'] ) ) {593			$check_permission = $this->check_role_update( $request['id'], $request['roles'] );594 595			if ( is_wp_error( $check_permission ) ) {596				return $check_permission;597			}598		}599 600		$user = $this->prepare_item_for_database( $request );601 602		if ( is_multisite() ) {603			$ret = wpmu_validate_user_signup( $user->user_login, $user->user_email );604 605			if ( is_wp_error( $ret['errors'] ) && $ret['errors']->has_errors() ) {606				$error = new WP_Error(607					'rest_invalid_param',608					__( 'Invalid user parameter(s).' ),609					array( 'status' => 400 )610				);611 612				foreach ( $ret['errors']->errors as $code => $messages ) {613					foreach ( $messages as $message ) {614						$error->add( $code, $message );615					}616 617					$error_data = $error->get_error_data( $code );618 619					if ( $error_data ) {620						$error->add_data( $error_data, $code );621					}622				}623				return $error;624			}625		}626 627		if ( is_multisite() ) {628			$user_id = wpmu_create_user( $user->user_login, $user->user_pass, $user->user_email );629 630			if ( ! $user_id ) {631				return new WP_Error(632					'rest_user_create',633					__( 'Error creating new user.' ),634					array( 'status' => 500 )635				);636			}637 638			$user->ID = $user_id;639			$user_id  = wp_update_user( wp_slash( (array) $user ) );640 641			if ( is_wp_error( $user_id ) ) {642				return $user_id;643			}644 645			$result = add_user_to_blog( get_site()->id, $user_id, '' );646			if ( is_wp_error( $result ) ) {647				return $result;648			}649		} else {650			$user_id = wp_insert_user( wp_slash( (array) $user ) );651 652			if ( is_wp_error( $user_id ) ) {653				return $user_id;654			}655		}656 657		$user = get_user_by( 'id', $user_id );658 659		/**660		 * Fires immediately after a user is created or updated via the REST API.

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 7.1.0 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.