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

Description

Parameters

$filearray

Reference to a single element of $_FILES. Call the function once for each uploaded file. See _wp_handle_upload() for accepted values.

$overridesarray|falseoptional

An associative array of names => values to override default variables. Default false. See _wp_handle_upload() for accepted values.Default: false

$timestring|nulloptional

Time formatted in 'yyyy/mm'. Default null.Default: null

Return

array

See _wp_handle_upload() for return value.

Uses · 1

• _wp_handle_upload()Handles PHP uploads in WordPress.

Used by · 7

• Custom_Background::handle_upload()Handles an Image upload for the background image.
• Custom_Image_Header::step_2_manage_upload()Uploads the file to be cropped in the second step.
• File_Upload_Upgrader::__construct()Construct the upgrader for a form.
• WP_REST_Attachments_Controller::upload_from_file()Handles an upload via multipart/form-data ($_FILES).
• WP_REST_Font_Faces_Controller::handle_font_file_upload()Handles the upload of a font file using wp_handle_upload().
• media_handle_upload()Saves a file submitted from a POST request and create an attachment post for it.
• wp_import_handle_upload()Handles importer uploading and adds attachment.

Source

View on Trac ↗View on GitHub ↗

1097function wp_handle_upload( &$file, $overrides = false, $time = null ) {1098	/*1099	 *  $_POST['action'] must be set and its value must equal $overrides['action']1100	 *  or this:1101	 */1102	$action = $overrides['action'] ?? 'wp_handle_upload';1103	return _wp_handle_upload( $file, $overrides, $time, $action );1104}

History

Introduced in 2.0.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 7.0.4 tag, from src/wp-admin/includes/file.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.