wppaste
WordPress

WP_REST_Posts_Controller::prepare_item_for_database( WP_REST_Request $request ): stdClass|WP_Error

Since
4.7.0
Source
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php:1257
Prepares a single post for create 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

stdClass|WP_Error
Post object or WP_Error.

Performance profile

How much work a call to WP_REST_Posts_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
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
80–143

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

Plugin surface
1 hook

Third-party callbacks on 'rest_pre_insert_{$this->post_type}' run inside this call, and their cost is not bounded by anything here.

Called by
3

3 places 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 callbacksapply_filters()called directly
  • optionoption read or writeget_option()one call below WP_REST_Posts_Controller::prepare_item_for_database()

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 · 10 distinct outcomes

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

WhenInstructionsCalls it makes
!isset($request) && !empty($request) && !empty($prepared_post) && post_password_required()80–93->get_item_schema(), get_post_type(), get_post_type_object(), post_password_required(), __()
!isset($request) && empty($value) && !empty($request)84–128->get_item_schema(), get_post_type(), get_post_type_object(), apply_filters()
!empty($request) && empty($parent)87–104->get_item_schema(), get_post_type(), get_post_type_object(), get_post(), __()
!isset($request) && !empty($request) && !empty($prepared_post) && !post_password_required()94–134->get_item_schema(), get_post_type(), get_post_type_object(), post_password_required(), apply_filters()
!empty($request) && !empty($prepared_post) && !post_password_required() && empty($parent)97–110->get_item_schema(), get_post_type(), get_post_type_object(), post_password_required(), get_post(), __()
!empty($request) && !empty($parent)102–137->get_item_schema(), get_post_type(), get_post_type_object(), get_post(), apply_filters()
!empty($request) && !empty($prepared_post) && !is_sticky()103–132->get_item_schema(), get_post_type(), get_post_type_object(), is_sticky(), apply_filters()
!empty($request) && !empty($prepared_post) && !is_sticky() && empty($parent)106–108->get_item_schema(), get_post_type(), get_post_type_object(), is_sticky(), get_post(), __()
!empty($request) && !empty($prepared_post) && !post_password_required() && !empty($parent)112–143->get_item_schema(), get_post_type(), get_post_type_object(), post_password_required(), get_post(), apply_filters()
!empty($request) && !empty($prepared_post) && !is_sticky() && !empty($parent)121–141->get_item_schema(), get_post_type(), get_post_type_object(), is_sticky(), get_post(), 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

PHPCompiledExecutedBranchesNotes
8.6-dev39580–14364
8.539580–14364
8.439580–14364
8.339580–14364
8.239580–14364
8.139580–143642 fewer instructions than PHP 7.4
7.439780–14364

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_Posts_Controller::prepare_item_for_database() runs, in this order:

  1. apply_filters( rest_pre_insert_{$this->post_type} )filterline 1471 (+214 into the body)

    Filters a post before it is inserted via the REST API.

Uses · 16

Show all 16

Used by · 3

Source code

View on Trac View on GitHub 

	protected function prepare_item_for_database( $request ) {		$prepared_post  = new stdClass();		$current_status = ''; 		// Post ID.		if ( isset( $request['id'] ) ) {			$existing_post = $this->get_post( $request['id'] );			if ( is_wp_error( $existing_post ) ) {				return $existing_post;			} 			$prepared_post->ID = $existing_post->ID;			$current_status    = $existing_post->post_status;		} 		$schema = $this->get_item_schema(); 		// Post title.		if ( ! empty( $schema['properties']['title'] ) && isset( $request['title'] ) ) {			if ( is_string( $request['title'] ) ) {				$prepared_post->post_title = $request['title'];			} elseif ( ! empty( $request['title']['raw'] ) ) {				$prepared_post->post_title = $request['title']['raw'];			}		} 		// Post content.		if ( ! empty( $schema['properties']['content'] ) && isset( $request['content'] ) ) {			if ( is_string( $request['content'] ) ) {				$prepared_post->post_content = $request['content'];			} elseif ( isset( $request['content']['raw'] ) ) {				$prepared_post->post_content = $request['content']['raw'];			}		} 		// Post excerpt.		if ( ! empty( $schema['properties']['excerpt'] ) && isset( $request['excerpt'] ) ) {			if ( is_string( $request['excerpt'] ) ) {				$prepared_post->post_excerpt = $request['excerpt'];			} elseif ( isset( $request['excerpt']['raw'] ) ) {				$prepared_post->post_excerpt = $request['excerpt']['raw'];			}		} 		// Post type.		if ( empty( $request['id'] ) ) {			// Creating new post, use default type for the controller.			$prepared_post->post_type = $this->post_type;		} else {			// Updating a post, use previous type.			$prepared_post->post_type = get_post_type( $request['id'] );		} 		$post_type = get_post_type_object( $prepared_post->post_type ); 		// Post status.		if (			! empty( $schema['properties']['status'] ) &&			isset( $request['status'] ) &&			( ! $current_status || $current_status !== $request['status'] )		) {			$status = $this->handle_status_param( $request['status'], $post_type ); 			if ( is_wp_error( $status ) ) {				return $status;			} 			$prepared_post->post_status = $status;		} 		// Post date.		if ( ! empty( $schema['properties']['date'] ) && ! empty( $request['date'] ) ) {			$current_date = isset( $prepared_post->ID ) ? get_post( $prepared_post->ID )->post_date : false;			$date_data    = rest_get_date_with_gmt( $request['date'] ); 			if ( ! empty( $date_data ) && $current_date !== $date_data[0] ) {				list( $prepared_post->post_date, $prepared_post->post_date_gmt ) = $date_data;				$prepared_post->edit_date                                        = true;			}		} elseif ( ! empty( $schema['properties']['date_gmt'] ) && ! empty( $request['date_gmt'] ) ) {

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.