Codex

Function Reference/media handle sideload

Contents

Description

Handles a sideloaded file in the same way as an uploaded file is handled by media_handle_upload().

Parameters

$file_array
(array) (required) Array similar to a $_FILES upload array.
Default: None
$post_id
(int) (required) The post ID the media is associated with.
Default: None
$desc
(string) (optional) Description of the sideloaded file.
Default: null
$post_data
(array) (optional) Allows you to overwrite some of the attachment.
Default: null

Return Value

(int|object)
The ID of the attachment or a WP_Error on failure.

Examples

(from the media_handle_upload() function) 

<?php 
	$url = "http://s.wordpress.org/style/images/wp3-logo.png";
	$tmp = download_url( $url );
	$post_id = 1;
	$desc = "The WordPress Logo";

	// Set variables for storage
	// fix file filename for query strings
	preg_match('/[^\?]+\.(jpg|JPG|jpe|JPE|jpeg|JPEG|gif|GIF|png|PNG)/', $file, $matches);
	$file_array['name'] = basename($matches[0]);
	$file_array['tmp_name'] = $tmp;

	// If error storing temporarily, unlink
	if ( is_wp_error( $tmp ) ) {
		@unlink($file_array['tmp_name']);
		$file_array['tmp_name'] = '';
	}

	// do the validation and storage stuff
	$id = media_handle_sideload( $file_array, $post_id, $desc );

	// If error storing permanently, unlink
	if ( is_wp_error($id) ) {
		@unlink($file_array['tmp_name']);
		return $id;
	}

	$src = wp_get_attachment_url( $id );
?>

Change Log

Since: 2.6.0

Source File

media_sideload_image() is located in wp-admin/includes/media.php.

Related

the_attachment_link(), get_attachment_link(), wp_get_attachment_link(), wp_get_attachment_image(), wp_get_attachment_image_src(), wp_get_attachment_url(), wp_get_attachment_thumb_file(), wp_get_attachment_thumb_url(), is_attachment(), wp_get_attachment_metadata()

See also index of Function Reference and index of Template Tags.
Retrieved from "http://codex.wordpress.org/Function_Reference/media_handle_sideload"

Codex Resources