WP_REST_Posts_Controller::create_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::create_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

12–189

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

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

2

2 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 callbacksdo_action()called directly
• optionoption read or writeget_option()one call below WP_REST_Posts_Controller::create_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 · 292 distinct outcomes

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

Hooks and filters fired · 2

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

1. 1
   do_action( rest_insert_{$this->post_type} )actionline 808 (+67 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 872 (+131 into the body)

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

Uses · 22

• __()Retrieves the translation of $text.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_unique_post_slug()Computes a unique slug for the post, when given the desired slug and some post details.
• wp_insert_post()Inserts or updates a post in the database.
• wp_slash()Adds slashes to a string or recursively adds slashes to strings within an array.
• get_post()Retrieves post data given a post ID or post object.
• do_action()Calls the callback functions that have been added to an action hook.
• stick_post()Makes a post sticky.
• unstick_post()Un-sticks a post.
• set_post_format()Assign a format to a post
• wp_after_insert_post()Fires actions after a post, its terms and meta data has been saved.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).

Used by · 2

• WP_REST_Font_Faces_Controller::create_item()Creates a font face for the parent font family.
• WP_REST_Font_Families_Controller::create_item()Creates a single font family.

Source code

View on Trac ↗View on GitHub ↗

741	public function create_item( $request ) {742		if ( ! empty( $request['id'] ) ) {743			return new WP_Error(744				'rest_post_exists',745				__( 'Cannot create existing post.' ),746				array( 'status' => 400 )747			);748		}749 750		$prepared_post = $this->prepare_item_for_database( $request );751 752		if ( is_wp_error( $prepared_post ) ) {753			return $prepared_post;754		}755 756		$prepared_post->post_type = $this->post_type;757 758		if ( ! empty( $prepared_post->post_name )759			&& ! empty( $prepared_post->post_status )760			&& in_array( $prepared_post->post_status, array( 'draft', 'pending' ), true )761		) {762			/*763			 * `wp_unique_post_slug()` returns the same slug for 'draft' or 'pending' posts.764			 *765			 * To ensure that a unique slug is generated, pass the post data with the 'publish' status.766			 */767			$prepared_post->post_name = wp_unique_post_slug(768				$prepared_post->post_name,769				$prepared_post->id,770				'publish',771				$prepared_post->post_type,772				$prepared_post->post_parent773			);774		}775 776		$post_id = wp_insert_post( wp_slash( (array) $prepared_post ), true, false );777 778		if ( is_wp_error( $post_id ) ) {779 780			if ( 'db_insert_error' === $post_id->get_error_code() ) {781				$post_id->add_data( array( 'status' => 500 ) );782			} else {783				$post_id->add_data( array( 'status' => 400 ) );784			}785 786			return $post_id;787		}788 789		$post = get_post( $post_id );790 791		/**792		 * Fires after a single post is created or updated via the REST API.793		 *794		 * The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.795		 *796		 * Possible hook names include:797		 *798		 *  - `rest_insert_post`799		 *  - `rest_insert_page`800		 *  - `rest_insert_attachment`801		 *802		 * @since 4.7.0803		 *804		 * @param WP_Post         $post     Inserted or updated post object.805		 * @param WP_REST_Request $request  Request object.806		 * @param bool            $creating True when creating a post, false when updating.807		 */808		do_action( "rest_insert_{$this->post_type}", $post, $request, true );809 810		$schema = $this->get_item_schema();811 812		if ( ! empty( $schema['properties']['sticky'] ) ) {813			if ( ! empty( $request['sticky'] ) ) {814				stick_post( $post_id );815			} else {816				unstick_post( $post_id );817			}818		}819 820		if ( ! empty( $schema['properties']['featured_media'] ) && isset( $request['featured_media'] ) ) {

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