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

Wrapper for _wp_handle_upload() .

Contents

Description

Passes the ‘wp_handle_upload’ 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_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 );
}

View on Trac View on GitHub

Top ↑

Top ↑

Used By

Used By
Used By Description
WP_REST_Attachments_Controller::upload_from_file() wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php

Handles an upload via multipart/form-data ($_FILES).
File_Upload_Upgrader::__construct() wp-admin/includes/class-file-upload-upgrader.php

Construct the upgrader for a form.
media_handle_upload() wp-admin/includes/media.php

Saves a file submitted from a POST request and create an attachment post for it.
wp_import_handle_upload() wp-admin/includes/import.php

Handles importer uploading and adds attachment.
Custom_Image_Header::step_2_manage_upload() wp-admin/includes/class-custom-image-header.php

Upload the file to be cropped in the second step.
Custom_Background::handle_upload() wp-admin/includes/class-custom-background.php

Handles an Image upload for the background image.
Show 1 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
2.0.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: 4You must log in to vote on the helpfulness of this note
    Contributed by Mohit Mishra — 
    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 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    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.