_wp_handle_upload
- %1$s is private and should not be used in themes or plugins directly.
_wp_handle_upload ( $file, $overrides, $time, $action )
Access:Parameters:- (array) file {
Reference to a single element from `$_FILES`. Call the function once for each uploaded file.
@type string $name The original name of the file on the client machine.
@type string $type The mime type of the file, if the browser provided this information.
@type string $tmp_name The temporary filename of the file in which the uploaded file was stored on the server.
@type int $size The size, in bytes, of the uploaded file.
@type int $error The error code associated with this file upload.
}
- (array|false) overrides {
An array of override parameters for this file, or boolean false if none are provided.
@type callable $upload_error_handler Function to call when there is an error during the upload process.
See {@see \wp_handle_upload_error()}.
@type callable $unique_filename_callback Function to call when determining a unique file name for the file.
See {@see \wp_unique_filename()}.
@type string[] $upload_error_strings The strings that describe the error indicated in
`$_FILES[{form field}]['error']`.
@type bool $test_form Whether to test that the `$_POST['action']` parameter is as expected.
@type bool $test_size Whether to test that the file size is greater than zero bytes.
@type bool $test_type Whether to test that the mime type of the file is as expected.
@type string[] $mimes Array of allowed mime types keyed by their file extension regex.
}
- (string) time Time formatted in 'yyyy/mm'.
- (string) action Expected value for `$_POST['action']`.
See:Returns:- (array) {
On success, returns an associative array of file attributes.
On failure, returns `$overrides['upload_error_handler']( &$file, $message )`
or `array( 'error' => $message )`.
@type string $file Filename of the newly-uploaded file.
@type string $url URL of the newly-uploaded file.
@type string $type Mime type of the newly-uploaded file.
}
Defined at: - Introduced in WordPress: 4.0.0
- Deprecated in WordPress: —
Description
Handles PHP uploads in WordPress.Sanitizes file names, checks extensions for mime type, and moves the file
to the appropriate directory within the uploads directory.