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

Wrapper for _wp_handle_upload() .

Description

Passes the ‘wp_handle_upload’ action.

See also

Parameters

$filearrayrequired
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.
$overridesarray|falseoptional
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

$timestringoptional
Time formatted in 'yyyy/mm'.

Default:null

Return

array See _wp_handle_upload() for return value.

Source

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

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

Changelog

VersionDescription
2.0.0Introduced.

User Contributed Notes

  1. Skip to note 3 content
    if ( ! function_exists( 'wp_handle_upload' ) ) {
    	require_once( ABSPATH . 'wp-admin/includes/file.php' );
    }
    // for multiple file upload.
    $upload_overrides = array( 'test_form' => false );
    $files = $_FILES['file'];
    foreach ( $files['name'] as $key => $value ) {
    	if ( $files['name'][ $key ] ) {
    		$file = array(
    			'name' => $files['name'][ $key ],
    			'type' => $files['type'][ $key ],
    			'tmp_name' => $files['tmp_name'][ $key ],
    			'error' => $files['error'][ $key ],
    			'size' => $files['size'][ $key ]
    		);
    
    		$movefile = wp_handle_upload( $file, $upload_overrides );
    	}
    }
    }
  2. Skip to note 4 content

    Example

    if ( ! function_exists( 'wp_handle_upload' ) ) {
        require_once( ABSPATH . 'wp-admin/includes/file.php' );
    }
    
    $uploadedfile = $_FILES['file'];
    
    $upload_overrides = array(
    	'test_form' => false
    );
    
    $movefile = wp_handle_upload( $uploadedfile, $upload_overrides );
    
    if ( $movefile && ! isset( $movefile['error'] ) ) {
        echo __( 'File is valid, and was successfully uploaded.', 'textdomain' ) . "\n";
        var_dump( $movefile );
    } else {
        /*
         * Error generated by _wp_handle_upload()
         * @see _wp_handle_upload() in wp-admin/includes/file.php
         */
        echo $movefile['error'];
    }

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