media_handle_sideload( string[] $file_array, int $post_id = 0, string $desc = null, array $post_data = array() ): int|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

$file_arraystring[]

Array that represents a $_FILES upload array.

$post_idintoptional

The post ID the media is associated with.Default: 0

$descstringoptional

Description of the side-loaded file. Default null.Default: null

$post_dataarrayoptional

Post data to override. Default empty array.Default: array()

Return value

int|WP_Error

The ID of the attachment or a WP_Error on failure.

Performance profile

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

29–100

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

Plugin surface

None

Nothing here hands control to plugin code.

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
• optionoption read or writeget_option()one call below media_handle_sideload()
• hookthird-party callbacksapply_filters()one call below media_handle_sideload()

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 · 15 distinct outcomes

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

Uses · 11

• get_post()Retrieves post data given a post ID or post object.
• current_time()Retrieves the current time based on specified type.
• wp_handle_sideload()Wrapper for _wp_handle_upload().
• 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.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_update_attachment_metadata()Updates metadata for an attachment.
• wp_generate_attachment_metadata()Generates attachment meta data and create image sub-sizes for images.
• WP_Error::__construct()Initializes the error.

Used by · 2

• WP_Customize_Manager::import_theme_starter_content()Imports theme starter content into the customized state.
• media_sideload_image()Downloads an image from the specified URL, saves it as an attachment, and optionally attaches it to a post.

Source code

View on Trac ↗View on GitHub ↗

455function media_handle_sideload( $file_array, $post_id = 0, $desc = null, $post_data = array() ) {456	$overrides = array( 'test_form' => false );457 458	if ( isset( $post_data['post_date'] ) && substr( $post_data['post_date'], 0, 4 ) > 0 ) {459		$time = $post_data['post_date'];460	} else {461		$post = get_post( $post_id );462		if ( $post && substr( $post->post_date, 0, 4 ) > 0 ) {463			$time = $post->post_date;464		} else {465			$time = current_time( 'mysql' );466		}467	}468 469	$file = wp_handle_sideload( $file_array, $overrides, $time );470 471	if ( isset( $file['error'] ) ) {472		return new WP_Error( 'upload_error', $file['error'] );473	}474 475	$url     = $file['url'];476	$type    = $file['type'];477	$file    = $file['file'];478	$title   = preg_replace( '/\.[^.]+$/', '', wp_basename( $file ) );479	$content = '';480 481	// Use image exif/iptc data for title and caption defaults if possible.482	$image_meta = wp_read_image_metadata( $file );483 484	if ( $image_meta ) {485		if ( trim( $image_meta['title'] ) && ! is_numeric( sanitize_title( $image_meta['title'] ) ) ) {486			$title = $image_meta['title'];487		}488 489		if ( trim( $image_meta['caption'] ) ) {490			$content = $image_meta['caption'];491		}492	}493 494	if ( isset( $desc ) ) {495		$title = $desc;496	}497 498	// Construct the attachment array.499	$attachment = array_merge(500		array(501			'post_mime_type' => $type,502			'guid'           => $url,503			'post_parent'    => $post_id,504			'post_title'     => $title,505			'post_content'   => $content,506		),507		$post_data508	);509 510	// This should never be set as it would then overwrite an existing attachment.511	unset( $attachment['ID'] );512 513	// Save the attachment metadata.514	$attachment_id = wp_insert_attachment( $attachment, $file, $post_id, true );515 516	if ( ! is_wp_error( $attachment_id ) ) {517		wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, $file ) );518	}519 520	return $attachment_id;521}

Changelog

Introduced in 2.6.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 6.7.7 tag, from src/wp-admin/includes/media.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.