WP_REST_Attachments_Controller::insert_attachment( WP_REST_Request $request ): array|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

Return value

array|WP_Error

Performance profile

How much work a call to WP_REST_Attachments_Controller::insert_attachment() 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

24–164

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

Plugin surface

1 hook

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

Called by

1

1 place 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

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

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 1

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

1. 1
   do_action( rest_insert_attachment )actionline 405 (+103 into the body)

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

Uses · 13

• get_post()Retrieves post data given a post ID or post object.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_basename()i18n-friendly version of basename().
• wp_read_image_metadata()Gets extended image metadata, exif or iptc as available.
• sanitize_title()Sanitizes a string into a slug, which can be used in URLs or HTML attributes.
• wp_insert_attachment()Inserts an attachment.
• wp_slash()Adds slashes to a string or recursively adds slashes to strings within an array.
• 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.
• do_action()Calls the callback functions that have been added to an action hook.
• WP_REST_Attachments_Controller::upload_from_file()Handles an upload via multipart/form-data ($_FILES).
• WP_REST_Attachments_Controller::upload_from_data()Handles an upload via raw POST data.

Used by · 1

• WP_REST_Attachments_Controller::create_item()Creates a single attachment.

Source code

View on Trac ↗View on GitHub ↗

302	protected function insert_attachment( $request ) {303		// Get the file via $_FILES or raw data.304		$files   = $request->get_file_params();305		$headers = $request->get_headers();306 307		$time = null;308 309		// Matches logic in media_handle_upload().310		if ( ! empty( $request['post'] ) ) {311			$post = get_post( $request['post'] );312			// The post date doesn't usually matter for pages, so don't backdate this upload.313			if ( $post && 'page' !== $post->post_type && substr( $post->post_date, 0, 4 ) > 0 ) {314				$time = $post->post_date;315			}316		}317 318		if ( ! empty( $files ) ) {319			$file = $this->upload_from_file( $files, $headers, $time );320		} else {321			$file = $this->upload_from_data( $request->get_body(), $headers, $time );322		}323 324		if ( is_wp_error( $file ) ) {325			return $file;326		}327 328		$name       = wp_basename( $file['file'] );329		$name_parts = pathinfo( $name );330		$name       = trim( substr( $name, 0, -( 1 + strlen( $name_parts['extension'] ) ) ) );331 332		$url  = $file['url'];333		$type = $file['type'];334		$file = $file['file'];335		$alt  = '';336 337		// Include image functions to get access to wp_read_image_metadata().338		require_once ABSPATH . 'wp-admin/includes/image.php';339 340		// Use image exif/iptc data for title and caption defaults if possible.341		$image_meta = wp_read_image_metadata( $file );342 343		if ( ! empty( $image_meta ) ) {344			if ( empty( $request['title'] ) && trim( $image_meta['title'] ) && ! is_numeric( sanitize_title( $image_meta['title'] ) ) ) {345				$request['title'] = $image_meta['title'];346			}347 348			if ( empty( $request['caption'] ) && trim( $image_meta['caption'] ) ) {349				$request['caption'] = $image_meta['caption'];350			}351 352			if ( empty( $request['alt'] ) && trim( $image_meta['alt'] ) ) {353				$alt = $image_meta['alt'];354			}355		}356 357		$attachment = $this->prepare_item_for_database( $request );358 359		$attachment->post_mime_type = $type;360		$attachment->guid           = $url;361 362		// If the title was not set, use the original filename.363		if ( empty( $attachment->post_title ) && ! empty( $files['file']['name'] ) ) {364			// Remove the file extension (after the last `.`)365			$tmp_title = substr( $files['file']['name'], 0, strrpos( $files['file']['name'], '.' ) );366 367			if ( ! empty( $tmp_title ) ) {368				$attachment->post_title = $tmp_title;369			}370		}371 372		// Fall back to the original approach.373		if ( empty( $attachment->post_title ) ) {374			$attachment->post_title = preg_replace( '/\.[^.]+$/', '', wp_basename( $file ) );375		}376 377		// $post_parent is inherited from $attachment['post_parent'].378		$id = wp_insert_attachment( wp_slash( (array) $attachment ), $file, 0, true, false );379 380		if ( trim( $alt ) ) {381			update_post_meta( $id, '_wp_attachment_image_alt', sanitize_text_field( $alt ) );

Changelog

Introduced in 5.3.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.0.4 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.