upload_dir

Filters the uploads directory data.

Description

apply_filters( 'upload_dir', (array) $cache_key ); 

Parameters (1)

0. $cache_key (array)
Array of upload directory data with keys of path,, url, subdir, .basedir', and error.

Usage

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

Defined (1)

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

/wp-includes/functions.php  
  1. $uploads = apply_filters( 'upload_dir', $cache[ $key ] );