<!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>[41716] trunk: Multisite: Establish `clean_blog_cache()` as a replacement for `refresh_blog_details()`.</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/41716">41716</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/41716","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>flixos90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-10-03 18:40:32 +0000 (Tue, 03 Oct 2017)</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'>Multisite: Establish `clean_blog_cache()` as a replacement for `refresh_blog_details()`.
Going forward, `clean_blog_cache()` is recommended to be used instead of `refresh_blog_details()`. It has been adjusted to match the functionality of the latter, with the exception that it always requires a site ID or object to be passed. The `refresh_blog_details` action has been deprecated in favor of the `clean_site_cache` action. The function itself is not formally deprecated at this point, but will likely be in the near future.
Props spacedmonkey.
Fixes <a href="https://core.trac.wordpress.org/ticket/40201">#40201</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesmsblogsphp">trunk/src/wp-includes/ms-blogs.php</a></li>
<li><a href="#trunktestsphpunittestsmultisitesitephp">trunk/tests/phpunit/tests/multisite/site.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesmsblogsphp"></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/ms-blogs.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/ms-blogs.php 2017-10-03 18:20:37 UTC (rev 41715)
+++ trunk/src/wp-includes/ms-blogs.php 2017-10-03 18:40:32 UTC (rev 41716)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -265,28 +265,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $blog_id = get_current_blog_id();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $details = get_site( $blog_id );
- if ( ! $details ) {
- // Make sure clean_blog_cache() gets the blog ID
- // when the blog has been previously cached as
- // non-existent.
- $details = (object) array(
- 'blog_id' => $blog_id,
- 'domain' => null,
- 'path' => null
- );
- }
-
- clean_blog_cache( $details );
-
- /**
- * Fires after the blog details cache is cleared.
- *
- * @since 3.4.0
- *
- * @param int $blog_id Blog ID.
- */
- do_action( 'refresh_blog_details', $blog_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ clean_blog_cache( $blog_id );
</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">@@ -443,7 +422,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global bool $_wp_suspend_cache_invalidation
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param WP_Site $blog The site object to be cleared from cache.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param WP_Site|int $blog The site object or ID to be cleared from cache.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function clean_blog_cache( $blog ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $_wp_suspend_cache_invalidation;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -452,6 +431,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</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">+ if ( empty( $blog ) ) {
+ return;
+ }
+
+ $blog_id = $blog;
+ $blog = get_site( $blog_id );
+ if ( ! $blog ) {
+ if ( ! is_numeric( $blog_id ) ) {
+ return;
+ }
+
+ // Make sure a WP_Site object exists even when the site has been deleted.
+ $blog = new WP_Site( (object) array(
+ 'blog_id' => $blog_id,
+ 'domain' => null,
+ 'path' => null,
+ ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $blog_id = $blog->blog_id;
</span><span class="cx" style="display: block; padding: 0 10px"> $domain_path_key = md5( $blog->domain . $blog->path );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -476,6 +474,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( 'clean_site_cache', $blog_id, $blog, $domain_path_key );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_set( 'last_changed', microtime(), 'sites' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Fires after the blog details cache is cleared.
+ *
+ * @since 3.4.0
+ * @deprecated 4.9.0 Use clean_site_cache
+ *
+ * @param int $blog_id Blog ID.
+ */
+ do_action_deprecated( 'refresh_blog_details', array( $blog_id ), '4.9.0', 'clean_site_cache' );
</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="trunktestsphpunittestsmultisitesitephp"></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/multisite/site.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/multisite/site.php 2017-10-03 18:20:37 UTC (rev 41715)
+++ trunk/tests/phpunit/tests/multisite/site.php 2017-10-03 18:40:32 UTC (rev 41716)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1086,7 +1086,33 @@
</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"> * @ticket 40201
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @dataProvider data_get_site_caches
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_clean_blog_cache_with_id( $key, $group ) {
+ $site = get_site( self::$site_ids['make.wordpress.org/'] );
+
+ $replacements = array(
+ '%blog_id%' => $site->blog_id,
+ '%domain%' => $site->domain,
+ '%path%' => $site->path,
+ '%domain_path_key%' => md5( $site->domain . $site->path ),
+ );
+
+ $key = str_replace( array_keys( $replacements ), array_values( $replacements ), $key );
+
+ if ( 'sites' === $group ) { // This needs to be actual data for get_site() lookups.
+ wp_cache_set( $key, (object) $site->to_array(), $group );
+ } else {
+ wp_cache_set( $key, 'something', $group );
+ }
+
+ clean_blog_cache( $site->blog_id );
+ $this->assertFalse( wp_cache_get( $key, $group ) );
+ }
+
+ /**
+ * @ticket 40201
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_clean_blog_cache_resets_last_changed() {
</span><span class="cx" style="display: block; padding: 0 10px"> $site = get_site( self::$site_ids['make.wordpress.org/'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1124,6 +1150,38 @@
</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"> * @ticket 40201
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ */
+ public function test_clean_blog_cache_bails_on_empty_input() {
+ $old_count = did_action( 'clean_site_cache' );
+
+ clean_blog_cache( null );
+ $this->assertEquals( $old_count, did_action( 'clean_site_cache' ) );
+ }
+
+ /**
+ * @ticket 40201
+ */
+ public function test_clean_blog_cache_bails_on_non_numeric_input() {
+ $old_count = did_action( 'clean_site_cache' );
+
+ clean_blog_cache( 'something' );
+ $this->assertEquals( $old_count, did_action( 'clean_site_cache' ) );
+ }
+
+ /**
+ * @ticket 40201
+ */
+ public function test_clean_blog_cache_works_with_deleted_site() {
+ $site_id = 12345;
+
+ wp_cache_set( $site_id, 'something', 'site-details' );
+
+ clean_blog_cache( $site_id );
+ $this->assertFalse( wp_cache_get( $site_id, 'site-details' ) );
+ }
+
+ /**
+ * @ticket 40201
</ins><span class="cx" style="display: block; padding: 0 10px"> * @dataProvider data_get_site_caches
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_refresh_blog_details( $key, $group ) {
</span></span></pre>
</div>
</div>
</body>
</html>