WP_REST_Attachments_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, WP_Error object on failure.

Performance profile

How much work a call to WP_REST_Attachments_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

18–191

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

Plugin surface

1 hook

Third-party callbacks on 'rest_after_insert_attachment' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksdo_action()called directly

Further down the call graph this can also reach serialize, cache, option 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 · 321 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while WP_REST_Attachments_Controller::create_item() runs, in this order:

1. 1
   do_action( rest_after_insert_attachment )actionline 610 (+100 into the body)

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

Uses · 23

• get_post_type()Retrieves the post type of the current post or of a given post.
• __()Retrieves the translation of $text.
• add_filter()Adds a callback function to a filter hook.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• update_post_meta()Updates a post meta field based on the given post ID.
• sanitize_text_field()Sanitizes a string from user input or from the database.
• 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.
• wp_after_insert_post()Fires actions after a post, its terms and meta data has been saved.
• wp_is_serving_rest_request()Determines whether WordPress is currently serving a REST API request.
• wp_update_attachment_metadata()Updates metadata for an attachment.
• wp_generate_attachment_metadata()Generates attachment meta data and create image sub-sizes for images.

Source code

View on Trac ↗View on GitHub ↗

510	public function create_item( $request ) {511		if ( ! empty( $request['post'] ) && in_array( get_post_type( $request['post'] ), array( 'revision', 'attachment' ), true ) ) {512			return new WP_Error(513				'rest_invalid_param',514				__( 'Invalid parent type.' ),515				array( 'status' => 400 )516			);517		}518 519		// Handle generate_sub_sizes parameter.520		if ( false === $request['generate_sub_sizes'] ) {521			add_filter( 'intermediate_image_sizes_advanced', '__return_empty_array', 100 );522			add_filter( 'fallback_intermediate_image_sizes', '__return_empty_array', 100 );523			// Disable server-side EXIF rotation so the client can handle it.524			// This preserves the original orientation value in the metadata.525			add_filter( 'wp_image_maybe_exif_rotate', '__return_false', 100 );526			// Disable server-side "big image" downscaling; the client supplies its527			// own scaled version via the sideload endpoint. Scaling here would528			// create a conflicting "-scaled" file and orphan the full-size upload.529			add_filter( 'big_image_size_threshold', '__return_false', 100 );530		}531 532		// Handle convert_format parameter.533		if ( false === $request['convert_format'] ) {534			add_filter( 'image_editor_output_format', '__return_empty_array', 100 );535		}536 537		/*538		 * When a URL is supplied instead of an uploaded file, sideload the539		 * remote image on the server. This avoids a cross-origin browser fetch,540		 * which fails under cross-origin isolation. The sub-size and scaling541		 * filters applied above still govern whether derivatives are generated.542		 */543		if ( ! empty( $request['url'] ) ) {544			$response = $this->create_item_from_url( $request );545			$this->remove_client_side_media_processing_filters();546			return $response;547		}548 549		$insert = $this->insert_attachment( $request );550 551		if ( is_wp_error( $insert ) ) {552			$this->remove_client_side_media_processing_filters();553			return $insert;554		}555 556		$schema = $this->get_item_schema();557 558		// Extract by name.559		$attachment_id = $insert['attachment_id'];560		$file          = $insert['file'];561 562		if ( isset( $request['alt_text'] ) ) {563			update_post_meta( $attachment_id, '_wp_attachment_image_alt', sanitize_text_field( $request['alt_text'] ) );564		}565 566		if ( ! empty( $schema['properties']['featured_media'] ) && isset( $request['featured_media'] ) ) {567			$thumbnail_update = $this->handle_featured_media( $request['featured_media'], $attachment_id );568 569			if ( is_wp_error( $thumbnail_update ) ) {570				$this->remove_client_side_media_processing_filters();571				return $thumbnail_update;572			}573		}574 575		if ( ! empty( $schema['properties']['meta'] ) && isset( $request['meta'] ) ) {576			$meta_update = $this->meta->update_value( $request['meta'], $attachment_id );577 578			if ( is_wp_error( $meta_update ) ) {579				$this->remove_client_side_media_processing_filters();580				return $meta_update;581			}582		}583 584		$attachment    = get_post( $attachment_id );585		$fields_update = $this->update_additional_fields_for_object( $attachment, $request );586 587		if ( is_wp_error( $fields_update ) ) {588			$this->remove_client_side_media_processing_filters();589			return $fields_update;

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