wppaste
WordPress

WP_REST_Users_Controller::prepare_item_for_database( WP_REST_Request $request ): object

Since
4.7.0
Source
wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php:1176
Prepares a single user for creation or update.

Compatibility

WordPress
since 4.7.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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
Request object.

Return value

object
User object.

Performance profile

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

Touches nothing outside its own arguments.

Scaling
Constant

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

Instructions
39–80

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

Plugin surface
1 hook

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

Called by
2

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

What it touches

  • hookthird-party callbacksapply_filters()called directly

What one call costs · 1 distinct outcome

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

WhenInstructionsCalls it makes
!isset($request)39–80->get_item_schema(), apply_filters()

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 114 instructions, 39–80 executed per call, 24 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Hooks and filters fired · 1

One hook fires while WP_REST_Users_Controller::prepare_item_for_database() runs, in this order:

  1. apply_filters( rest_pre_insert_user )filterline 1244 (+68 into the body)

    Filters user data before insertion via the REST API.

Uses · 4

Used by · 2

Source code

View on Trac View on GitHub 

	protected function prepare_item_for_database( $request ) {		$prepared_user = new stdClass(); 		$schema = $this->get_item_schema(); 		// Required arguments.		if ( isset( $request['email'] ) && ! empty( $schema['properties']['email'] ) ) {			$prepared_user->user_email = $request['email'];		} 		if ( isset( $request['username'] ) && ! empty( $schema['properties']['username'] ) ) {			$prepared_user->user_login = $request['username'];		} 		if ( isset( $request['password'] ) && ! empty( $schema['properties']['password'] ) ) {			$prepared_user->user_pass = $request['password'];		} 		// Optional arguments.		if ( isset( $request['id'] ) ) {			$prepared_user->ID = absint( $request['id'] );		} 		if ( isset( $request['name'] ) && ! empty( $schema['properties']['name'] ) ) {			$prepared_user->display_name = $request['name'];		} 		if ( isset( $request['first_name'] ) && ! empty( $schema['properties']['first_name'] ) ) {			$prepared_user->first_name = $request['first_name'];		} 		if ( isset( $request['last_name'] ) && ! empty( $schema['properties']['last_name'] ) ) {			$prepared_user->last_name = $request['last_name'];		} 		if ( isset( $request['nickname'] ) && ! empty( $schema['properties']['nickname'] ) ) {			$prepared_user->nickname = $request['nickname'];		} 		if ( isset( $request['slug'] ) && ! empty( $schema['properties']['slug'] ) ) {			$prepared_user->user_nicename = $request['slug'];		} 		if ( isset( $request['description'] ) && ! empty( $schema['properties']['description'] ) ) {			$prepared_user->description = $request['description'];		} 		if ( isset( $request['url'] ) && ! empty( $schema['properties']['url'] ) ) {			$prepared_user->user_url = $request['url'];		} 		if ( isset( $request['locale'] ) && ! empty( $schema['properties']['locale'] ) ) {			$prepared_user->locale = $request['locale'];		} 		// Setting roles will be handled outside of this function.		if ( isset( $request['roles'] ) ) {			$prepared_user->role = false;		} 		/**		 * Filters user data before insertion via the REST API.		 *		 * @since 4.7.0		 *		 * @param object          $prepared_user User object.		 * @param WP_REST_Request $request       Request object.		 */		return apply_filters( 'rest_pre_insert_user', $prepared_user, $request );	}

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