_wp_upload_dir( string|null $time = null ): array

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$timestring|nulloptional

Time formatted in 'yyyy/mm'. Default null.Default: null

Return value

array

See wp_upload_dir()

Performance profile

How much work a call to _wp_upload_dir() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

40–121

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 145.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()one call below _wp_upload_dir()
• cacheobject cachewp_cache_get()one call below _wp_upload_dir()
• serializeserialisationmaybe_unserialize()one call below _wp_upload_dir()

Further down the call graph this can also reach query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 384 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost _wp_upload_dir() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 12

• get_option()Retrieves an option value based on an option name.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• path_join()Joins two filesystem paths together.
• trailingslashit()Appends a trailing slash.
• is_multisite()Determines whether Multisite is enabled.
• get_site_option()Retrieve an option value for the current network based on name of option.
• is_main_network()Determines whether a network is the main network of the Multisite installation.
• is_main_site()Determines whether a site is the main site of the current network.
• get_current_blog_id()Retrieves the current site ID.
• ms_is_switched()Determines if switch_to_blog() is in effect.
• untrailingslashit()Removes trailing forward slashes and backslashes if they exist.
• current_time()Retrieves the current time based on specified type.

Used by · 1

• wp_upload_dir()Returns an array containing the current upload directory's path and URL.

Source code

View on Trac ↗View on GitHub ↗

2467function _wp_upload_dir( $time = null ) {2468	$siteurl     = get_option( 'siteurl' );2469	$upload_path = trim( get_option( 'upload_path' ) );2470 2471	if ( empty( $upload_path ) || 'wp-content/uploads' === $upload_path ) {2472		$dir = WP_CONTENT_DIR . '/uploads';2473	} elseif ( ! str_starts_with( $upload_path, ABSPATH ) ) {2474		// $dir is absolute, $upload_path is (maybe) relative to ABSPATH.2475		$dir = path_join( ABSPATH, $upload_path );2476	} else {2477		$dir = $upload_path;2478	}2479 2480	$url = get_option( 'upload_url_path' );2481	if ( ! $url ) {2482		if ( empty( $upload_path ) || ( 'wp-content/uploads' === $upload_path ) || ( $upload_path === $dir ) ) {2483			$url = WP_CONTENT_URL . '/uploads';2484		} else {2485			$url = trailingslashit( $siteurl ) . $upload_path;2486		}2487	}2488 2489	/*2490	 * Honor the value of UPLOADS. This happens as long as ms-files rewriting is disabled.2491	 * We also sometimes obey UPLOADS when rewriting is enabled -- see the next block.2492	 */2493	if ( defined( 'UPLOADS' ) && ! ( is_multisite() && get_site_option( 'ms_files_rewriting' ) ) ) {2494		$dir = ABSPATH . UPLOADS;2495		$url = trailingslashit( $siteurl ) . UPLOADS;2496	}2497 2498	// If multisite (and if not the main site in a post-MU network).2499	if ( is_multisite() && ! ( is_main_network() && is_main_site() && defined( 'MULTISITE' ) ) ) {2500 2501		if ( ! get_site_option( 'ms_files_rewriting' ) ) {2502			/*2503			 * If ms-files rewriting is disabled (networks created post-3.5), it is fairly2504			 * straightforward: Append sites/%d if we're not on the main site (for post-MU2505			 * networks). (The extra directory prevents a four-digit ID from conflicting with2506			 * a year-based directory for the main site. But if a MU-era network has disabled2507			 * ms-files rewriting manually, they don't need the extra directory, as they never2508			 * had wp-content/uploads for the main site.)2509			 */2510 2511			if ( defined( 'MULTISITE' ) ) {2512				$ms_dir = '/sites/' . get_current_blog_id();2513			} else {2514				$ms_dir = '/' . get_current_blog_id();2515			}2516 2517			$dir .= $ms_dir;2518			$url .= $ms_dir;2519 2520		} elseif ( defined( 'UPLOADS' ) && ! ms_is_switched() ) {2521			/*2522			 * Handle the old-form ms-files.php rewriting if the network still has that enabled.2523			 * When ms-files rewriting is enabled, then we only listen to UPLOADS when:2524			 * 1) We are not on the main site in a post-MU network, as wp-content/uploads is used2525			 *    there, and2526			 * 2) We are not switched, as ms_upload_constants() hardcodes these constants to reflect2527			 *    the original blog ID.2528			 *2529			 * Rather than UPLOADS, we actually use BLOGUPLOADDIR if it is set, as it is absolute.2530			 * (And it will be set, see ms_upload_constants().) Otherwise, UPLOADS can be used, as2531			 * as it is relative to ABSPATH. For the final piece: when UPLOADS is used with ms-files2532			 * rewriting in multisite, the resulting URL is /files. (#WP22702 for background.)2533			 */2534 2535			if ( defined( 'BLOGUPLOADDIR' ) ) {2536				$dir = untrailingslashit( BLOGUPLOADDIR );2537			} else {2538				$dir = ABSPATH . UPLOADS;2539			}2540			$url = trailingslashit( $siteurl ) . 'files';2541		}2542	}2543 2544	$basedir = $dir;2545	$baseurl = $url;2546

Changelog

Introduced in 4.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/functions.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.