wp_handle_upload( array $file, array|bool $overrides = false, string $time = null )
Wrapper for _wp_handle_upload().
Description
Passes the ‘wp_handle_upload’ action.
See also
Parameters
- $file
-
(Required) Reference to a single element of
$_FILES. Call the function once for each uploaded file. - $overrides
-
(Optional) An associative array of names=>values to override default variables.
Default value: false
- $time
-
(Optional) Time formatted in 'yyyy/mm'.
Default value: null
Return
(array) On success, returns an associative array of file attributes. On failure, returns $overrides['upload_error_handler'](&$file, $message ) or array( 'error'=>$message ).
Source
File: wp-admin/includes/file.php
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
| Version | Description |
|---|---|
| WP-2.0.0 | Introduced. |