<action>_prefilter

Filters the data for a file before it is uploaded to WordPress.

Description

apply_filters( '<action>_prefilter', (array) $file ); 

The dynamic portion(s) of the hook name refer to the post action.

Parameters (1)

0. $file (array)
An array of data for a single file.

Usage

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

Defined (1)

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

/wp-admin/includes/file.php  
  1. $file = apply_filters( "{$action}_prefilter", $file );