WP_REST_Posts_Controller::create_item( WP_REST_Request $request ): WP_REST_Response|WP_Error

In this article

Creates a single post.

Parameters

$requestWP_REST_Requestrequired
Full details about the request.

Return

WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.

Source

public function create_item( $request ) {
	if ( ! empty( $request['id'] ) ) {
		return new WP_Error(
			'rest_post_exists',
			__( 'Cannot create existing post.' ),
			array( 'status' => 400 )
		);
	}

	$prepared_post = $this->prepare_item_for_database( $request );

	if ( is_wp_error( $prepared_post ) ) {
		return $prepared_post;
	}

	$prepared_post->post_type = $this->post_type;

	if ( ! empty( $prepared_post->post_name )
		&& ! empty( $prepared_post->post_status )
		&& in_array( $prepared_post->post_status, array( 'draft', 'pending' ), true )
	) {
		/*
		 * `wp_unique_post_slug()` returns the same slug for 'draft' or 'pending' posts.
		 *
		 * To ensure that a unique slug is generated, pass the post data with the 'publish' status.
		 */
		$prepared_post->post_name = wp_unique_post_slug(
			$prepared_post->post_name,
			$prepared_post->id,
			'publish',
			$prepared_post->post_type,
			$prepared_post->post_parent
		);
	}

	$post_id = wp_insert_post( wp_slash( (array) $prepared_post ), true, false );

	if ( is_wp_error( $post_id ) ) {

		if ( 'db_insert_error' === $post_id->get_error_code() ) {
			$post_id->add_data( array( 'status' => 500 ) );
		} else {
			$post_id->add_data( array( 'status' => 400 ) );
		}

		return $post_id;
	}

	$post = get_post( $post_id );

	/**
	 * Fires after a single post is created or updated via the REST API.
	 *
	 * The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
	 *
	 * Possible hook names include:
	 *
	 *  - `rest_insert_post`
	 *  - `rest_insert_page`
	 *  - `rest_insert_attachment`
	 *
	 * @since 4.7.0
	 *
	 * @param WP_Post         $post     Inserted or updated post object.
	 * @param WP_REST_Request $request  Request object.
	 * @param bool            $creating True when creating a post, false when updating.
	 */
	do_action( "rest_insert_{$this->post_type}", $post, $request, true );

	$schema = $this->get_item_schema();

	if ( ! empty( $schema['properties']['sticky'] ) ) {
		if ( ! empty( $request['sticky'] ) ) {
			stick_post( $post_id );
		} else {
			unstick_post( $post_id );
		}
	}

	if ( ! empty( $schema['properties']['featured_media'] ) && isset( $request['featured_media'] ) ) {
		$this->handle_featured_media( $request['featured_media'], $post_id );
	}

	if ( ! empty( $schema['properties']['format'] ) && ! empty( $request['format'] ) ) {
		set_post_format( $post, $request['format'] );
	}

	if ( ! empty( $schema['properties']['template'] ) && isset( $request['template'] ) ) {
		$this->handle_template( $request['template'], $post_id, true );
	}

	$terms_update = $this->handle_terms( $post_id, $request );

	if ( is_wp_error( $terms_update ) ) {
		return $terms_update;
	}

	if ( ! empty( $schema['properties']['meta'] ) && isset( $request['meta'] ) ) {
		$meta_update = $this->meta->update_value( $request['meta'], $post_id );

		if ( is_wp_error( $meta_update ) ) {
			return $meta_update;
		}
	}

	$post          = get_post( $post_id );
	$fields_update = $this->update_additional_fields_for_object( $post, $request );

	if ( is_wp_error( $fields_update ) ) {
		return $fields_update;
	}

	$request->set_param( 'context', 'edit' );

	/**
	 * Fires after a single post is completely created or updated via the REST API.
	 *
	 * The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
	 *
	 * Possible hook names include:
	 *
	 *  - `rest_after_insert_post`
	 *  - `rest_after_insert_page`
	 *  - `rest_after_insert_attachment`
	 *
	 * @since 5.0.0
	 *
	 * @param WP_Post         $post     Inserted or updated post object.
	 * @param WP_REST_Request $request  Request object.
	 * @param bool            $creating True when creating a post, false when updating.
	 */
	do_action( "rest_after_insert_{$this->post_type}", $post, $request, true );

	wp_after_insert_post( $post, false, null );

	$response = $this->prepare_item_for_response( $post, $request );
	$response = rest_ensure_response( $response );

	$response->set_status( 201 );
	$response->header( 'Location', rest_url( rest_get_route_for_post( $post ) ) );

	return $response;
}

Hooks

do_action( “rest_after_insert_{$this->post_type}”, WP_Post $post, WP_REST_Request $request, bool $creating )

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

do_action( “rest_insert_{$this->post_type}”, WP_Post $post, WP_REST_Request $request, bool $creating )

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

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

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