sanitize_file_name

Filters a sanitized filename string.

Description

apply_filters( 'sanitize_file_name', (string) $filename, (string) $filename_raw ); 

Parameters (2)

0. $filename (string)
Sanitized filename.
1. $filename_raw (string)
The filename prior to sanitization.

Usage

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

Defined (2)

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

/wp-includes/formatting.php  
  1. return apply_filters( 'sanitize_file_name', $filename, $filename_raw ); 
  1. return apply_filters( 'sanitize_file_name', $filename, $filename_raw );