WP_REST_Templates_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_Templates_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

Heavy

Reaches the database via get_post().

Scaling

Constant

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

Instructions

20–98

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

Plugin surface

1 hook

Third-party callbacks on 'rest_after_insert_{$this->post_type}' 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_post()called directly
• hookthird-party callbacksdo_action()called directly
• optionoption read or writeget_option()one call below WP_REST_Templates_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 · 9 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while WP_REST_Templates_Controller::update_item() runs, in this order:

1. 1
   do_action( rest_after_insert_{$this->post_type} )actionline 419 (+52 into the body)

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

Uses · 15

• get_block_template()Retrieves a single unified template object using its id.
• __()Retrieves the translation of $text.
• get_post()Retrieves post data given a post ID or post object.
• wp_delete_post()Trashes or deletes a post or page.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_update_post()Updates a post with new post data.
• wp_slash()Adds slashes to a string or recursively adds slashes to strings within an array.
• wp_insert_post()Inserts or updates a post in the database.
• do_action()Calls the callback functions that have been added to an action hook.
• wp_after_insert_post()Fires actions after a post, its terms and meta data has been saved.
• WP_Error::__construct()Initializes the error.

Source code

View on Trac ↗View on GitHub ↗

367	public function update_item( $request ) {368		$template = get_block_template( $request['id'], $this->post_type );369		if ( ! $template ) {370			return new WP_Error( 'rest_template_not_found', __( 'No templates exist with that id.' ), array( 'status' => 404 ) );371		}372 373		$post_before = get_post( $template->wp_id );374 375		if ( isset( $request['source'] ) && 'theme' === $request['source'] ) {376			wp_delete_post( $template->wp_id, true );377			$request->set_param( 'context', 'edit' );378 379			$template = get_block_template( $request['id'], $this->post_type );380			$response = $this->prepare_item_for_response( $template, $request );381 382			return rest_ensure_response( $response );383		}384 385		$changes = $this->prepare_item_for_database( $request );386 387		if ( is_wp_error( $changes ) ) {388			return $changes;389		}390 391		if ( 'custom' === $template->source ) {392			$update = true;393			$result = wp_update_post( wp_slash( (array) $changes ), false );394		} else {395			$update      = false;396			$post_before = null;397			$result      = wp_insert_post( wp_slash( (array) $changes ), false );398		}399 400		if ( is_wp_error( $result ) ) {401			if ( 'db_update_error' === $result->get_error_code() ) {402				$result->add_data( array( 'status' => 500 ) );403			} else {404				$result->add_data( array( 'status' => 400 ) );405			}406			return $result;407		}408 409		$template      = get_block_template( $request['id'], $this->post_type );410		$fields_update = $this->update_additional_fields_for_object( $template, $request );411		if ( is_wp_error( $fields_update ) ) {412			return $fields_update;413		}414 415		$request->set_param( 'context', 'edit' );416 417		$post = get_post( $template->wp_id );418		/** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php */419		do_action( "rest_after_insert_{$this->post_type}", $post, $request, false );420 421		wp_after_insert_post( $post, $update, $post_before );422 423		$response = $this->prepare_item_for_response( $template, $request );424 425		return rest_ensure_response( $response );426	}

Changelog

Introduced in 5.8.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-templates-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.