wp_delete_file

Filters the path of the file to delete.

Description

apply_filters( 'wp_delete_file', (string) $file ); 

Parameters (1)

0. $file (string)
Path to the file to delete.

Usage

To run the hook, copy the example below.
  1. $file = apply_filters( 'wp_delete_file', $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 wp_delete_file callback 
  2. function filter_wp_delete_file( $file ) { 
  3. // make filter magic happen here... 
  4. return $file
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'wp_delete_file', 'filter_wp_delete_file', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'wp_delete_file', 'filter_wp_delete_file', 10, 1 ); 

Defined (4)

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

/wp-includes/functions.php  
  1. $delete = apply_filters( 'wp_delete_file', $file ); 
/wp-includes/post.php  
  1. $thumbfile = apply_filters( 'wp_delete_file', $thumbfile ); 
  1. $intermediate_file = apply_filters( 'wp_delete_file', $intermediate_file ); 
  1. $del_file = apply_filters( 'wp_delete_file', $del_file );