wp_relative_upload_path

Filters the relative path to an uploaded file.

Description

apply_filters( 'wp_relative_upload_path', (string) $new_path, (string) $path ); 

Parameters (2)

0. $new_path (string)
Relative path to the file.
1. $path (string)
Full path to the file.

Usage

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

Defined (1)

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

/wp-includes/post.php  
  1. return apply_filters( '_wp_relative_upload_path', $new_path, $path );