WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

upload_dir

apply_filters( ‘upload_dir’, array $uploads )

In this article

Back to top

Filters the uploads directory data.

Parameters

$uploadsarray
Array of information about the upload directory.
  • path string
    Base directory and subdirectory or full path to upload directory.
  • url string
    Base URL and subdirectory or absolute URL to upload directory.
  • subdir string
    Subdirectory if uploads use year/month folders option is on.
  • basedir string
    Path without subdir.
  • baseurl string
    URL path without subdir.
  • error string|false
    False or error message.

More Information

This hook allows you to change the directory where files are uploaded to. The keys and values in the array are used by the wp_upload_dir()  function in wordpress core, which is doing the work

Source

$uploads = apply_filters( 'upload_dir', $cache[ $key ] );

View all references View on Trac View on GitHub

Used byDescription
wp_upload_dir()wp-includes/functions.php

Returns an array containing the current upload directory’s path and URL.

Changelog

VersionDescription
2.0.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Collins Mbaka
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    This goes into your plugin.

    add_filter('upload_dir', 'awesome_wallpaper_dir');

function awesome_wallpaper_dir( $param ){
    $mydir = '/awesome';

    $param['path'] = $param['path'] . $mydir;
    $param['url'] = $param['url'] . $mydir;

    return $param;
}

    If your plugin is written as a class, you’ll want to hook to it like this:

    add_filter( 'upload_dir', array( $this, 'awesome_wallpaper_dir' ) );

    Using this, in conjunction with the wp_handle_upload_prefilter, you can dynamically determine which directory to upload to, based on the files you upload.

You must log in before being able to contribute a note or feedback.