<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[36565] trunk: Improve the performance of `wp_upload_dir()`:</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/36565">36565</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/36565","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>azaozz</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-02-17 22:51:01 +0000 (Wed, 17 Feb 2016)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Improve the performance of `wp_upload_dir()`:
- Cache the output in non-persistent cache.
- Cache the result from `wp_mkdir_p()` in persistent cache (when present).
- Introduce `wp_get_upload_dir()` for use when not uploading files. It is equivalent to `wp_upload_dir()` but does not check for the existence or create the upload directory.
- Change tests to use the non-cached `_wp_upload_dir()`. They change options on the fly (should never be used in production) to simulate different environments.
- Introduce `_upload_dir_no_subdir()` and `_upload_dir_https()` to facilitate testing. These use the proper `upload_dir` filter to simulate different environments.
Props kovshenin, azaozz.
See <a href="https://core.trac.wordpress.org/ticket/34359">#34359</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
<li><a href="#trunktestsphpunitincludesfunctionsphp">trunk/tests/phpunit/includes/functions.php</a></li>
<li><a href="#trunktestsphpunittestsmediaphp">trunk/tests/phpunit/tests/media.php</a></li>
<li><a href="#trunktestsphpunittestspostattachmentsphp">trunk/tests/phpunit/tests/post/attachments.php</a></li>
<li><a href="#trunktestsphpunittestsuploadphp">trunk/tests/phpunit/tests/upload.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.php 2016-02-17 22:03:50 UTC (rev 36564)
+++ trunk/src/wp-includes/functions.php 2016-02-17 22:51:01 UTC (rev 36565)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1800,6 +1800,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Get uploads directory information.
+ *
+ * Same as wp_upload_dir() but "light weight" as it doesn't attempt to create the uploads directory.
+ * Intended for use in themes, when only 'basedir' and 'baseurl' are needed, generally in all cases when not uploading files.
+ *
+ * @since 4.5.0
+ *
+ * @return array See wp_upload_dir() for description.
+ */
+function wp_get_upload_dir() {
+ return wp_upload_dir( null, false );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Get an array containing the current upload directory's path and url.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Checks the 'upload_path' option, which should be from the web root folder,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1824,14 +1838,73 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * 'subdir' - sub directory if uploads use year/month folders option is on.
</span><span class="cx" style="display: block; padding: 0 10px"> * 'basedir' - path without subdir.
</span><span class="cx" style="display: block; padding: 0 10px"> * 'baseurl' - URL path without subdir.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 'error' - set to false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 'error' - false or error message.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @uses _wp_upload_dir()
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $create_dir Optional. Whether to check and create the uploads directory. Default true (backwards compatible).
+ * @param bool $refresh_cache Optional. Whether to refresh the cache. Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array See above for description.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function wp_upload_dir( $time = null ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function wp_upload_dir( $time = null, $create_dir = true, $refresh_cache = false ) {
+ static $cache = array();
+
+ $key = sprintf( '%d-%s', get_current_blog_id(), (string) $time );
+
+ if ( $refresh_cache || empty( $cache[ $key ] ) ) {
+ $cache[ $key ] = _wp_upload_dir( $time );
+ }
+
+ /**
+ * Filter the uploads directory data.
+ *
+ * @since 2.0.0
+ *
+ * @param array $uploads Array of upload directory data with keys of 'path',
+ * 'url', 'subdir, 'basedir', and 'error'.
+ */
+ $uploads = apply_filters( 'upload_dir', $cache[ $key ] );
+
+ if ( $create_dir ) {
+ $path = $uploads['path'];
+ $tested_paths = wp_cache_get( 'upload_dir_tested_paths' );
+
+ if ( ! is_array( $tested_paths ) ) {
+ $tested_paths = array();
+ }
+
+ 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 = basename( $uploads['basedir'] ) . $uploads['subdir'];
+ }
+
+ $uploads['error'] = sprintf( __( 'Unable to create directory %s. Is its parent directory writable by the server?' ), $error_path );
+ }
+
+ $tested_paths[ $path ] = $uploads['error'];
+ wp_cache_set( 'upload_dir_tested_paths', $tested_paths );
+ }
+ }
+
+ return $uploads;
+}
+
+/**
+ * A non-filtered, non-cached version of wp_upload_dir() that doesn't check the path.
+ *
+ * @access private
+ *
+ * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null.
+ * @return array See wp_upload_dir()
+ */
+function _wp_upload_dir( $time = null ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $siteurl = get_option( 'siteurl' );
</span><span class="cx" style="display: block; padding: 0 10px"> $upload_path = trim( get_option( 'upload_path' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1920,36 +1993,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $dir .= $subdir;
</span><span class="cx" style="display: block; padding: 0 10px"> $url .= $subdir;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /**
- * Filter the uploads directory data.
- *
- * @since 2.0.0
- *
- * @param array $uploads Array of upload directory data with keys of 'path',
- * 'url', 'subdir, 'basedir', and 'error'.
- */
- $uploads = apply_filters( 'upload_dir',
- array(
- 'path' => $dir,
- 'url' => $url,
- 'subdir' => $subdir,
- 'basedir' => $basedir,
- 'baseurl' => $baseurl,
- 'error' => false,
- ) );
-
- // Make sure we have an uploads directory.
- if ( ! wp_mkdir_p( $uploads['path'] ) ) {
- if ( 0 === strpos( $uploads['basedir'], ABSPATH ) )
- $error_path = str_replace( ABSPATH, '', $uploads['basedir'] ) . $uploads['subdir'];
- else
- $error_path = basename( $uploads['basedir'] ) . $uploads['subdir'];
-
- $message = sprintf( __( 'Unable to create directory %s. Is its parent directory writable by the server?' ), $error_path );
- $uploads['error'] = $message;
- }
-
- return $uploads;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return array(
+ 'path' => $dir,
+ 'url' => $url,
+ 'subdir' => $subdir,
+ 'basedir' => $basedir,
+ 'baseurl' => $baseurl,
+ 'error' => false,
+ );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunktestsphpunitincludesfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/functions.php 2016-02-17 22:03:50 UTC (rev 36564)
+++ trunk/tests/phpunit/includes/functions.php 2016-02-17 22:51:01 UTC (rev 36565)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -115,3 +115,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function _set_default_permalink_structure_for_tests() {
</span><span class="cx" style="display: block; padding: 0 10px"> update_option( 'permalink_structure', '/%year%/%monthnum%/%day%/%postname%/' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Helper used with the `upload_dir` filter to remove the /year/month sub directories from the uploads path and URL.
+ */
+function _upload_dir_no_subdir( $uploads ) {
+ $subdir = $uploads['subdir'];
+
+ $uploads['subdir'] = '';
+ $uploads['path'] = str_replace( $subdir, '', $uploads['path'] );
+ $uploads['url'] = str_replace( $subdir, '', $uploads['url'] );
+
+ return $uploads;
+}
+
+/**
+ * Helper used with the `upload_dir` filter to set https upload URL.
+ */
+function _upload_dir_https( $uploads ) {
+ $uploads['url'] = str_replace( 'http://', 'https://', $uploads['url'] );
+ $uploads['baseurl'] = str_replace( 'http://', 'https://', $uploads['baseurl'] );
+
+ return $uploads;
+}
</ins></span></pre></div>
<a id="trunktestsphpunittestsmediaphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/media.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/media.php 2016-02-17 22:03:50 UTC (rev 36564)
+++ trunk/tests/phpunit/tests/media.php 2016-02-17 22:51:01 UTC (rev 36565)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -895,11 +895,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function test_wp_calculate_image_srcset_no_date_uploads() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $_wp_additional_image_sizes;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Save the current setting for uploads folders
- $uploads_use_yearmonth_folders = get_option( 'uploads_use_yearmonth_folders' );
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Disable date organized uploads
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- update_option( 'uploads_use_yearmonth_folders', 0 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_filter( 'upload_dir', '_upload_dir_no_subdir' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Make an image.
</span><span class="cx" style="display: block; padding: 0 10px"> $filename = DIR_TESTDATA . '/images/test-image-large.png';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -937,9 +934,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Remove the attachment
</span><span class="cx" style="display: block; padding: 0 10px"> wp_delete_attachment( $id );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- // Leave the uploads option the way you found it.
- update_option( 'uploads_use_yearmonth_folders', $uploads_use_yearmonth_folders );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ remove_filter( 'upload_dir', '_upload_dir_no_subdir' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunktestsphpunittestspostattachmentsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/post/attachments.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/post/attachments.php 2016-02-17 22:03:50 UTC (rev 36564)
+++ trunk/tests/phpunit/tests/post/attachments.php 2016-02-17 22:51:01 UTC (rev 36565)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -441,9 +441,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 15928
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_wp_get_attachment_url_should_force_https_when_administering_over_https_and_siteurl_is_https() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Must set the upload_url_path to fake out `wp_upload_dir()`.
- $siteurl = get_option( 'siteurl' );
- update_option( 'upload_url_path', set_url_scheme( $siteurl, 'https' ) . '/uploads' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Set https upload URL
+ add_filter( 'upload_dir', '_upload_dir_https' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $filename = ( DIR_TESTDATA . '/images/test-image.jpg' );
</span><span class="cx" style="display: block; padding: 0 10px"> $contents = file_get_contents( $filename );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -463,6 +462,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Cleanup.
</span><span class="cx" style="display: block; padding: 0 10px"> $_SERVER['HTTPS'] = $is_ssl ? 'on' : 'off';
</span><span class="cx" style="display: block; padding: 0 10px"> set_current_screen( 'front' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ remove_filter( 'upload_dir', '_upload_dir_https' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( set_url_scheme( $url, 'https' ), $url );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsuploadphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/upload.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/upload.php 2016-02-17 22:03:50 UTC (rev 36564)
+++ trunk/tests/phpunit/tests/upload.php 2016-02-17 22:51:01 UTC (rev 36565)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -26,22 +26,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function test_upload_dir_default() {
</span><span class="cx" style="display: block; padding: 0 10px"> // wp_upload_dir() with default parameters
</span><span class="cx" style="display: block; padding: 0 10px"> $info = wp_upload_dir();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( get_option( 'siteurl' ) . '/wp-content/uploads/' . gmstrftime('%Y/%m'), $info['url'] );
- $this->assertEquals( ABSPATH . 'wp-content/uploads/' . gmstrftime('%Y/%m'), $info['path'] );
- $this->assertEquals( gmstrftime('/%Y/%m'), $info['subdir'] );
- $this->assertEquals( '', $info['error'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $subdir = gmstrftime('/%Y/%m');
+
+ $this->assertEquals( get_option( 'siteurl' ) . '/wp-content/uploads' . $subdir, $info['url'] );
+ $this->assertEquals( ABSPATH . 'wp-content/uploads' . $subdir, $info['path'] );
+ $this->assertEquals( $subdir, $info['subdir'] );
+ $this->assertEquals( false, $info['error'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> function test_upload_dir_relative() {
</span><span class="cx" style="display: block; padding: 0 10px"> // wp_upload_dir() with a relative upload path that is not 'wp-content/uploads'
</span><span class="cx" style="display: block; padding: 0 10px"> update_option( 'upload_path', 'foo/bar' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $info = wp_upload_dir();
- $this->delete_folders( ABSPATH . 'foo' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $info = _wp_upload_dir();
+ $subdir = gmstrftime('/%Y/%m');
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( get_option( 'siteurl' ) . '/foo/bar/' . gmstrftime('%Y/%m'), $info['url'] );
- $this->assertEquals( ABSPATH . 'foo/bar/' . gmstrftime('%Y/%m'), $info['path'] );
- $this->assertEquals( gmstrftime('/%Y/%m'), $info['subdir'] );
- $this->assertEquals( '', $info['error'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( get_option( 'siteurl' ) . '/foo/bar' . $subdir, $info['url'] );
+ $this->assertEquals( ABSPATH . 'foo/bar' . $subdir, $info['path'] );
+ $this->assertEquals( $subdir, $info['subdir'] );
+ $this->assertEquals( false, $info['error'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -49,45 +51,63 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_upload_dir_absolute() {
</span><span class="cx" style="display: block; padding: 0 10px"> $path = '/tmp/wp-unit-test';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> // wp_upload_dir() with an absolute upload path
</span><span class="cx" style="display: block; padding: 0 10px"> update_option( 'upload_path', $path );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> // doesn't make sense to use an absolute file path without setting the url path
</span><span class="cx" style="display: block; padding: 0 10px"> update_option( 'upload_url_path', '/baz' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $info = wp_upload_dir();
- $this->delete_folders( $path );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( '/baz/' . gmstrftime('%Y/%m'), $info['url'] );
- $this->assertEquals( "$path/" . gmstrftime('%Y/%m'), $info['path'] );
- $this->assertEquals( gmstrftime('/%Y/%m'), $info['subdir'] );
- $this->assertEquals( '', $info['error'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Use `_wp_upload_dir()` directly to bypass caching and work with the changed options.
+ // It doesn't create the /year/month directories.
+ $info = _wp_upload_dir();
+ $subdir = gmstrftime('/%Y/%m');
+
+ $this->assertEquals( '/baz' . $subdir, $info['url'] );
+ $this->assertEquals( $path . $subdir, $info['path'] );
+ $this->assertEquals( $subdir, $info['subdir'] );
+ $this->assertEquals( false, $info['error'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> function test_upload_dir_no_yearnum() {
</span><span class="cx" style="display: block; padding: 0 10px"> update_option( 'uploads_use_yearmonth_folders', 0 );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $info = wp_upload_dir();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Use `_wp_upload_dir()` directly to bypass caching and work with the changed options.
+ $info = _wp_upload_dir();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( get_option( 'siteurl' ) . '/wp-content/uploads', $info['url'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( ABSPATH . 'wp-content/uploads', $info['path'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( '', $info['subdir'] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( '', $info['error'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( false, $info['error'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> function test_upload_path_absolute() {
</span><span class="cx" style="display: block; padding: 0 10px"> update_option( 'upload_url_path', 'http://example.org/asdf' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $info = wp_upload_dir();
- $this->assertEquals( 'http://example.org/asdf/' . gmstrftime('%Y/%m'), $info['url'] );
- $this->assertEquals( ABSPATH . 'wp-content/uploads/' . gmstrftime('%Y/%m'), $info['path'] );
- $this->assertEquals( gmstrftime('/%Y/%m'), $info['subdir'] );
- $this->assertEquals( '', $info['error'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Use `_wp_upload_dir()` directly to bypass caching and work with the changed options.
+ // It doesn't create the /year/month directories.
+ $info = _wp_upload_dir();
+ $subdir = gmstrftime('/%Y/%m');
+
+ $this->assertEquals( 'http://example.org/asdf' . $subdir, $info['url'] );
+ $this->assertEquals( ABSPATH . 'wp-content/uploads' . $subdir, $info['path'] );
+ $this->assertEquals( $subdir, $info['subdir'] );
+ $this->assertEquals( false, $info['error'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> function test_upload_dir_empty() {
</span><span class="cx" style="display: block; padding: 0 10px"> // upload path setting is empty - it should default to 'wp-content/uploads'
</span><span class="cx" style="display: block; padding: 0 10px"> update_option('upload_path', '');
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $info = wp_upload_dir();
- $this->assertEquals( get_option( 'siteurl' ) . '/wp-content/uploads/' . gmstrftime('%Y/%m'), $info['url'] );
- $this->assertEquals( ABSPATH . 'wp-content/uploads/' . gmstrftime('%Y/%m'), $info['path'] );
- $this->assertEquals( gmstrftime('/%Y/%m'), $info['subdir'] );
- $this->assertEquals( '', $info['error'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Use `_wp_upload_dir()` directly to bypass caching and work with the changed options.
+ // It doesn't create the /year/month directories.
+ $info = _wp_upload_dir();
+ $subdir = gmstrftime('/%Y/%m');
+
+ $this->assertEquals( get_option( 'siteurl' ) . '/wp-content/uploads' . $subdir, $info['url'] );
+ $this->assertEquals( ABSPATH . 'wp-content/uploads' . $subdir, $info['path'] );
+ $this->assertEquals( $subdir, $info['subdir'] );
+ $this->assertEquals( false, $info['error'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>