WP_REST_Posts_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_Posts_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

52–198

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

Plugin surface

2 hooks

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

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

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

Hooks and filters fired · 2

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

1. 1
   do_action( rest_insert_{$this->post_type} )actionline 966 (+50 into the body)

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

2. 2
   do_action( rest_after_insert_{$this->post_type} )actionline 1020 (+104 into the body)

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

Uses · 19

• is_wp_error()Checks whether the given variable is a WordPress Error.
• get_post()Retrieves post data given a post ID or post object.
• wp_unique_post_slug()Computes a unique slug for the post, when given the desired slug and some post details.
• 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.
• do_action()Calls the callback functions that have been added to an action hook.
• set_post_format()Assign a format to a post
• stick_post()Makes a post sticky.
• unstick_post()Un-sticks a post.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• wp_after_insert_post()Fires actions after a post, its terms and meta data has been saved.
• WP_REST_Posts_Controller::get_post()Gets the post, if the ID is valid.

Used by · 1

• WP_REST_Attachments_Controller::update_item()Updates a single attachment.

Source code

View on Trac ↗View on GitHub ↗

916	public function update_item( $request ) {917		$valid_check = $this->get_post( $request['id'] );918		if ( is_wp_error( $valid_check ) ) {919			return $valid_check;920		}921 922		$post_before = get_post( $request['id'] );923		$post        = $this->prepare_item_for_database( $request );924 925		if ( is_wp_error( $post ) ) {926			return $post;927		}928 929		if ( ! empty( $post->post_status ) ) {930			$post_status = $post->post_status;931		} else {932			$post_status = $post_before->post_status;933		}934 935		/*936		 * `wp_unique_post_slug()` returns the same slug for 'draft' or 'pending' posts.937		 *938		 * To ensure that a unique slug is generated, pass the post data with the 'publish' status.939		 */940		if ( ! empty( $post->post_name ) && in_array( $post_status, array( 'draft', 'pending' ), true ) ) {941			$post_parent     = ! empty( $post->post_parent ) ? $post->post_parent : 0;942			$post->post_name = wp_unique_post_slug(943				$post->post_name,944				$post->ID,945				'publish',946				$post->post_type,947				$post_parent948			);949		}950 951		// Convert the post object to an array, otherwise wp_update_post() will expect non-escaped input.952		$post_id = wp_update_post( wp_slash( (array) $post ), true, false );953 954		if ( is_wp_error( $post_id ) ) {955			if ( 'db_update_error' === $post_id->get_error_code() ) {956				$post_id->add_data( array( 'status' => 500 ) );957			} else {958				$post_id->add_data( array( 'status' => 400 ) );959			}960			return $post_id;961		}962 963		$post = get_post( $post_id );964 965		/** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php */966		do_action( "rest_insert_{$this->post_type}", $post, $request, false );967 968		$schema = $this->get_item_schema();969 970		if ( ! empty( $schema['properties']['format'] ) && ! empty( $request['format'] ) ) {971			set_post_format( $post, $request['format'] );972		}973 974		if ( ! empty( $schema['properties']['featured_media'] ) && isset( $request['featured_media'] ) ) {975			$this->handle_featured_media( $request['featured_media'], $post_id );976		}977 978		if ( ! empty( $schema['properties']['sticky'] ) && isset( $request['sticky'] ) ) {979			if ( ! empty( $request['sticky'] ) ) {980				stick_post( $post_id );981			} else {982				unstick_post( $post_id );983			}984		}985 986		if ( ! empty( $schema['properties']['template'] ) && isset( $request['template'] ) ) {987			$this->handle_template( $request['template'], $post->ID );988		}989 990		$terms_update = $this->handle_terms( $post->ID, $request );991 992		if ( is_wp_error( $terms_update ) ) {993			return $terms_update;994		}995

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.7.7 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-posts-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.