WP_REST_Users_Controller::prepare_item_for_database( WP_REST_Request $request ): object

In this article

Prepares a single user for creation or update.

Parameters

$requestWP_REST_Requestrequired
Request object.

Return

object User object.

Source

	 * @param WP_REST_Response $response The response object.
	 * @param WP_User          $user     User object used to create response.
	 * @param WP_REST_Request  $request  Request object.
	 */
	return apply_filters( 'rest_prepare_user', $response, $user, $request );
}

/**
 * Prepares links for the user request.
 *
 * @since 4.7.0
 *
 * @param WP_User $user User object.
 * @return array Links for the given user.
 */
protected function prepare_links( $user ) {
	$links = array(
		'self'       => array(
			'href' => rest_url( sprintf( '%s/%s/%d', $this->namespace, $this->rest_base, $user->ID ) ),
		),
		'collection' => array(
			'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ),
		),
	);

	return $links;
}

/**
 * Prepares a single user for creation or update.
 *
 * @since 4.7.0
 *
 * @param WP_REST_Request $request Request object.
 * @return object User object.
 */
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'];
	}

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

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