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

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

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 value

array

See _wp_handle_upload() for return value.

Performance profile

How much work a call to wp_handle_upload() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

13–15

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 15.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

7

7 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()one call below wp_handle_upload()

Further down the call graph this can also reach transient, option, cache, query and serialize. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_handle_upload() can have, taken from its control-flow graph on PHP 8.5.

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 code

View on Trac ↗View on GitHub ↗

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

Changelog

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 6.9.7 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.