wp_handle_sideload( array $file, array|false $overrides = false, string $time = null ): array

Wrapper for _wp_handle_upload() .

Contents

Description

Passes the ‘wp_handle_sideload’ action.

Top ↑

See also

Top ↑

Parameters

$file array Required
Reference to a single element of $_FILES.
Call the function once for each uploaded file.
See _wp_handle_upload() for accepted values.
More Arguments from _wp_handle_upload( ... $file ) Reference to a single element from $_FILES. Call the function once for each uploaded file.
  • name string
    The original name of the file on the client machine.
  • type string
    The mime type of the file, if the browser provided this information.
  • tmp_name string
    The temporary filename of the file in which the uploaded file was stored on the server.
  • size int
    The size, in bytes, of the uploaded file.
  • error int
    The error code associated with this file upload.
$overrides array|false Optional
An associative array of names => values to override default variables.
See _wp_handle_upload() for accepted values.
More Arguments from _wp_handle_upload( ... $overrides ) An array of override parameters for this file, or boolean false if none are provided.
  • upload_error_handler callable
    Function to call when there is an error during the upload process.
    @see wp_handle_upload_error() .
  • unique_filename_callback callable
    Function to call when determining a unique file name for the file.
    @see wp_unique_filename() .
  • upload_error_strings string[]
    The strings that describe the error indicated in $_FILES[{form field}]['error'].
  • test_form bool
    Whether to test that the $_POST['action'] parameter is as expected.
  • test_size bool
    Whether to test that the file size is greater than zero bytes.
  • test_type bool
    Whether to test that the mime type of the file is as expected.
  • mimes string[]
    Array of allowed mime types keyed by their file extension regex.

Default: false

$time string Optional
Time formatted in 'yyyy/mm'.

Default: null

Top ↑

Return

array See _wp_handle_upload() for return value.

Top ↑

Source

File: wp-admin/includes/file.php. View all references 

function wp_handle_sideload( &$file, $overrides = false, $time = null ) {
	/*
	 *  $_POST['action'] must be set and its value must equal $overrides['action']
	 *  or this:
	 */
	$action = 'wp_handle_sideload';
	if ( isset( $overrides['action'] ) ) {
		$action = $overrides['action'];
	}

	return _wp_handle_upload( $file, $overrides, $time, $action );
}

View on Trac View on GitHub

Top ↑

Top ↑

Changelog

Changelog
Version Description
2.6.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Example

    This example uses download_url() to download the logo from wordpress.org and then moves it into the uploads directory.

    // Gives us access to the download_url() and wp_handle_sideload() functions.
require_once( ABSPATH . 'wp-admin/includes/file.php' );

// URL to the WordPress logo.
$url = 'https://s.w.org/style/images/wp-header-logo.png';
$timeout_seconds = 5;

// Download file to temp dir.
$temp_file = download_url( $url, $timeout_seconds );

if ( ! is_wp_error( $temp_file ) ) {

	// Array based on $_FILE as seen in PHP file uploads.
	$file = array(
		'name'     => basename($url), // ex: wp-header-logo.png
		'type'     => 'image/png',
		'tmp_name' => $temp_file,
		'error'    => 0,
		'size'     => filesize( $temp_file ),
	);

	$overrides = array(
		/*
		 * Tells WordPress to not look for the POST form fields that would
		 * normally be present, default is true, we downloaded the file from
		 * a remote server, so there will be no form fields.
		 */
		'test_form' => false,

		// Setting this to false lets WordPress allow empty files, not recommended.
		'test_size' => true,

		// A properly uploaded file will pass this test. There should be no reason to override this one.
		'test_upload' => true, 
	);

	// Move the temporary file into the uploads directory.
	$results = wp_handle_sideload( $file, $overrides );

	if ( ! empty( $results['error'] ) ) {
		// Insert any error handling here.
	} else {
		$filename  = $results['file']; // Full path to the file.
		$local_url = $results['url'];  // URL to the file in the uploads dir.
		$type      = $results['type']; // MIME type of the file.

		// Perform any actions here based in the above results.
	}
}
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
    Contributed by Vladut Ilie —

    If you want to rename your uploaded file and you use a PHP class it is needed to do the callback like this:

    class My_Class {
	public function my_custom_upload() {
		// Getting file information
		$file = isset( $_FILES ) ? $_FILES : array();
		
		// For exemple it is an image
		$allowed_mimes = array(
			'jpg|jpeg|jpe'	=> 'image/jpeg',
			'gif'			=> 'image/gif',
			'png'			=> 'image/png',
		);

		$uploaded_file = wp_handle_sideload( $file['image'], array(
				'test_form' => false,
				'mimes'		=> $allowed_mimes,
				'unique_filename_callback' => array( $this, 'rename_uploaded_file' ),
			)
		);
	}

	public static function rename_uploaded_file( $dir, $name, $ext ) {
		return 'some_string' . $name . $ext;
	}
}

You must log in before being able to contribute a note or feedback.