Skip to content

Add upload_url() helper to retrieve the uploads directory URL #9865

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
himanshupathak95 wants to merge 5 commits into
base: trunk
Choose a base branch
from
Open

Add upload_url() helper to retrieve the uploads directory URL #9865

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c2efdf1
Add `upload_url()` helper to retrieve the uploads directory URL
himanshupathak95 Sep 12, 2025
43efd7f
Fix linting
himanshupathak95 Sep 12, 2025
d1f9d38
Improve the doc block comments
himanshupathak95 Sep 12, 2025
6b02339
Tests: Add unit test for `upload_url()` function with default settings
himanshupathak95 Sep 15, 2025
619f39e
Tests: Add unit test for `upload_url()` function when year/month fold…
himanshupathak95 Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions src/wp-includes/link-template.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3662,6 +3662,29 @@ function content_url( $path = '' ) {
return apply_filters( 'content_url', $url, $path );
}

/**
* Retrieves the uploads directory URL.
*
* Returns either the base uploads URL (e.g. https://example.com/wp-content/uploads)
* or, when requested, the URL to the current time-based subdirectory
* (e.g. https://example.com/wp-content/uploads/2025/09) if year/month folders are enabled.
*
* @since 6.9.0
*
* @param bool $with_subdir Optional. Whether to include the time-based subdirectory
* when it is configured. Default true.
* @return string Uploads URL. Empty string on failure.
*/
function upload_url( $with_subdir = true ) {
$uploads = wp_upload_dir();

if ( ! empty( $uploads['error'] ) ) {
return '';
}

return $with_subdir ? $uploads['url'] : $uploads['baseurl'];
}

/**
* Retrieves a URL within the plugins or mu-plugins directory.
*
Expand Down
29 changes: 29 additions & 0 deletions tests/phpunit/tests/upload.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,4 +105,33 @@ public function test_upload_dir_empty() {
$this->assertSame( $subdir, $info['subdir'] );
$this->assertFalse( $info['error'] );
}

/**
* Tests the upload_url() function with default settings.
*
* @ticket 33963
*/
public function test_upload_url() {
$expected = wp_upload_dir();
$this->assertFalse( $expected['error'] );

$this->assertSame( $expected['url'], upload_url() );
$this->assertSame( $expected['url'], upload_url( true ) );
$this->assertSame( $expected['baseurl'], upload_url( false ) );
}

/**
* Tests the upload_url() function when year/month folders are disabled.
*
* @ticket 33963
*/
public function test_upload_url_without_yearmonth_folders() {
update_option( 'uploads_use_yearmonth_folders', 0 );

$expected = wp_upload_dir();

$this->assertFalse( $expected['error'] );
$this->assertSame( $expected['url'], upload_url() );
$this->assertSame( $expected['baseurl'], upload_url( false ) );
}
}
Loading