wp_handle_sideload( array $file, array|false $overrides = false, string $time = null )
Wrapper for _wp_handle_upload().
Description
Passes the ‘wp_handle_sideload’ action.
See also
Parameters
- $file
-
(array) (Required) Reference to a single element of
$_FILES. Call the function once for each uploaded file. - $overrides
-
(array|false) (Optional) An associative array of names => values to override default variables.
Default value: false
- $time
-
(string) (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_sideload( &$file, $overrides = false, $time = null ) {
/*
* $_POST['action'] must be set and its value must equal $overrides['action']
* or this:
*/
$action = 'wp_handle_sideload';
if ( isset( $overrides['action'] ) ) {
$action = $overrides['action'];
}
return _wp_handle_upload( $file, $overrides, $time, $action );
} Changelog
| Version | Description |
|---|---|
| 2.6.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_handle_sideload