wp_handle_upload

Filters the data array for the uploaded file.

Description

apply_filters( 'wp_handle_upload', (callback) $array, (string) $sideload ); 

Parameters (2)

0. $array — Optional. (callback) => array( 'file' => $new_file, 'url' => $url, 'type' => $wp_filetype['type'], 'error' => false )
The array.
1. $sideload (string) => 'sideload'
The sideload.

Usage

To run the hook, copy the example below.
  1. $array = apply_filters( 'wp_handle_upload', $array, $sideload ); 
  2.  
  3. if ( !empty( $array ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the wp_handle_upload callback 
  2. function filter_wp_handle_upload( $array, $sideload ) { 
  3. // make filter magic happen here... 
  4. return $array
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'wp_handle_upload', 'filter_wp_handle_upload', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'wp_handle_upload', 'filter_wp_handle_upload', 10, 2 ); 

Defined (2)

The filter is defined in the following location(s).

/wp-includes/functions.php  
  1. return apply_filters( 'wp_handle_upload', array( 'file' => $new_file, 'url' => $url, 'type' => $wp_filetype['type'], 'error' => false ), 'sideload' ); 
/wp-admin/includes/file.php  
  1. return apply_filters( 'wp_handle_upload', array(