WP_REST_Attachments_Controller::create_item │ public │ WP 4.7.0

Creates a single attachment.

Method of the class: WP_REST_Attachments_Controller{}

Returns

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

Usage

$WP_REST_Attachments_Controller = new WP_REST_Attachments_Controller();
$WP_REST_Attachments_Controller->create_item( $request );

$request(WP_REST_Request) (required)

Full details about the request.

Changelog

WP_REST_Attachments_Controller::create_item() WP REST Attachments Controller::create item code ^{WP 7.1}

public function create_item( $request ) {
	if ( ! empty( $request['post'] ) && in_array( get_post_type( $request['post'] ), array( 'revision', 'attachment' ), true ) ) {
		return new WP_Error(
			'rest_invalid_param',
			__( 'Invalid parent type.' ),
			array( 'status' => 400 )
		);
	}

	// Handle generate_sub_sizes parameter.
	if ( false === $request['generate_sub_sizes'] ) {
		add_filter( 'intermediate_image_sizes_advanced', '__return_empty_array', 100 );
		add_filter( 'fallback_intermediate_image_sizes', '__return_empty_array', 100 );
		// Disable server-side EXIF rotation so the client can handle it.
		// This preserves the original orientation value in the metadata.
		add_filter( 'wp_image_maybe_exif_rotate', '__return_false', 100 );
		// Disable server-side "big image" downscaling; the client supplies its
		// own scaled version via the sideload endpoint. Scaling here would
		// create a conflicting "-scaled" file and orphan the full-size upload.
		add_filter( 'big_image_size_threshold', '__return_false', 100 );
	}

	// Handle convert_format parameter.
	if ( false === $request['convert_format'] ) {
		add_filter( 'image_editor_output_format', '__return_empty_array', 100 );
	}

	/*
	 * When a URL is supplied instead of an uploaded file, sideload the
	 * remote image on the server. This avoids a cross-origin browser fetch,
	 * which fails under cross-origin isolation. The sub-size and scaling
	 * filters applied above still govern whether derivatives are generated.
	 */
	if ( ! empty( $request['url'] ) ) {
		$response = $this->create_item_from_url( $request );
		$this->remove_client_side_media_processing_filters();
		return $response;
	}

	$insert = $this->insert_attachment( $request );

	if ( is_wp_error( $insert ) ) {
		$this->remove_client_side_media_processing_filters();
		return $insert;
	}

	$schema = $this->get_item_schema();

	// Extract by name.
	$attachment_id = $insert['attachment_id'];
	$file          = $insert['file'];

	if ( isset( $request['alt_text'] ) ) {
		update_post_meta( $attachment_id, '_wp_attachment_image_alt', sanitize_text_field( $request['alt_text'] ) );
	}

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

		if ( is_wp_error( $thumbnail_update ) ) {
			$this->remove_client_side_media_processing_filters();
			return $thumbnail_update;
		}
	}

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

		if ( is_wp_error( $meta_update ) ) {
			$this->remove_client_side_media_processing_filters();
			return $meta_update;
		}
	}

	$attachment    = get_post( $attachment_id );
	$fields_update = $this->update_additional_fields_for_object( $attachment, $request );

	if ( is_wp_error( $fields_update ) ) {
		$this->remove_client_side_media_processing_filters();
		return $fields_update;
	}

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

	if ( is_wp_error( $terms_update ) ) {
		$this->remove_client_side_media_processing_filters();
		return $terms_update;
	}

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

	/**
	 * Fires after a single attachment is completely created or updated via the REST API.
	 *
	 * @since 5.0.0
	 *
	 * @param WP_Post         $attachment Inserted or updated attachment object.
	 * @param WP_REST_Request $request    Request object.
	 * @param bool            $creating   True when creating an attachment, false when updating.
	 */
	do_action( 'rest_after_insert_attachment', $attachment, $request, true );

	wp_after_insert_post( $attachment, false, null );

	if ( wp_is_serving_rest_request() ) {
		/*
		 * Set a custom header with the attachment_id.
		 * Used by the browser/client to resume creating image sub-sizes after a PHP fatal error.
		 */
		header( 'X-WP-Upload-Attachment-ID: ' . $attachment_id );
	}

	// Include media and image functions to get access to wp_generate_attachment_metadata().
	require_once ABSPATH . 'wp-admin/includes/media.php';
	require_once ABSPATH . 'wp-admin/includes/image.php';

	/*
	 * Post-process the upload (create image sub-sizes, make PDF thumbnails, etc.) and insert attachment meta.
	 * At this point the server may run out of resources and post-processing of uploaded images may fail.
	 */
	wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, $file ) );

	$this->remove_client_side_media_processing_filters();

	$response = $this->prepare_item_for_response( $attachment, $request );
	$response = rest_ensure_response( $response );
	$response->set_status( 201 );
	$response->header( 'Location', rest_url( sprintf( '%s/%s/%d', $this->namespace, $this->rest_base, $attachment_id ) ) );

	return $response;
}