WordPress at a glance

wp_upload_dir() WP 1.0

Get an array containing the current upload directory's path and url.

Checks the 'upload_path' option, which should be from the web root folder, and if it isn't empty it will be used. If it is empty, then the path will be 'WP_CONTENT_DIR/uploads'. If the 'UPLOADS' constant is defined, then it will override the 'upload_path' option and 'WP_CONTENT_DIR/uploads' path.

The upload URL path is set either by the 'upload_url_path' option or by using the 'WP_CONTENT_URL' constant and appending '/uploads' to the path.

If the 'uploads_use_yearmonth_folders' is set to true (checkbox if checked in the administration settings panel), then the time will be used. The format will be year first and then month.

If the path couldn't be created, then an error will be returned with the key 'error' containing the error message. The error suggests that the parent directory is not writable by the server.

Is the basis for: wp_get_upload_dir()
Works based on: _wp_upload_dir()
✈ 1 time = 0.000233s = fast | 50000 times = 0.23s = very fast | PHP 7.0.5, WP 4.5
Hooks from the function
Return

Array. 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.

Usage

wp_upload_dir( $time, $create_dir, $refresh_cache );
$time(string)
Time formatted in 'yyyy/mm'.
Default: null
$create_dir(true/false)
Whether to check and create the uploads directory.
Default: true for backward compatibility
$refresh_cache(true/false)
Whether to refresh the cache.
Default: false

Notes

  • Static. Array. $cache
  • Static. Array. $tested_paths

Changelog

Since 2.0.0 Introduced.

Code of wp upload dir: wp-includes/functions.php WP 5.4.1

<?php
function wp_upload_dir( $time = null, $create_dir = true, $refresh_cache = false ) {
	static $cache = array(), $tested_paths = array();

	$key = sprintf( '%d-%s', get_current_blog_id(), (string) $time );

	if ( $refresh_cache || empty( $cache[ $key ] ) ) {
		$cache[ $key ] = _wp_upload_dir( $time );
	}

	/**
	 * Filters the uploads directory data.
	 *
	 * @since 2.0.0
	 *
	 * @param array $uploads {
	 *     Array of information about the upload directory.
	 *
	 *     @type string       $path    Base directory and subdirectory or full path to upload directory.
	 *     @type string       $url     Base URL and subdirectory or absolute URL to upload directory.
	 *     @type string       $subdir  Subdirectory if uploads use year/month folders option is on.
	 *     @type string       $basedir Path without subdir.
	 *     @type string       $baseurl URL path without subdir.
	 *     @type string|false $error   False or error message.
	 * }
	 */
	$uploads = apply_filters( 'upload_dir', $cache[ $key ] );

	if ( $create_dir ) {
		$path = $uploads['path'];

		if ( array_key_exists( $path, $tested_paths ) ) {
			$uploads['error'] = $tested_paths[ $path ];
		} else {
			if ( ! wp_mkdir_p( $path ) ) {
				if ( 0 === strpos( $uploads['basedir'], ABSPATH ) ) {
					$error_path = str_replace( ABSPATH, '', $uploads['basedir'] ) . $uploads['subdir'];
				} else {
					$error_path = wp_basename( $uploads['basedir'] ) . $uploads['subdir'];
				}

				$uploads['error'] = sprintf(
					/* translators: %s: Directory path. */
					__( 'Unable to create directory %s. Is its parent directory writable by the server?' ),
					esc_html( $error_path )
				);
			}

			$tested_paths[ $path ] = $uploads['error'];
		}
	}

	return $uploads;
}

Related Functions

From tag: path (directory folder)

More from tag: Link (URL)

More from category: Upload/Download

No comments
        Log In . Register