<!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>[41861] trunk: Multisite: Take `WP_Network::$blog_id` into account in `get_main_site_id()`.</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/41861">41861</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/41861","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-14 22:41:15 +0000 (Sat, 14 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: Take `WP_Network::$blog_id` into account in `get_main_site_id()`.
When the `WP_Network::$blog_id` property is set manually, for example in the multisite bootstrap process, `get_main_site_id()` should use that value instead of running its own logic. The main logic for the function was therefore moved into the internal `WP_Network::get_main_site_id()` method, which is now being accessed by the function through the magic property handling for `WP_Network::$blog_id` (and its equivalent `WP_Network::$site_id`).
Props spacedmonkey, jeremyfelt.
Fixes <a href="https://core.trac.wordpress.org/ticket/41936">#41936</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpnetworkphp">trunk/src/wp-includes/class-wp-network.php</a></li>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
<li><a href="#trunktestsphpunittestsmultisitegetMainSiteIdphp">trunk/tests/phpunit/tests/multisite/getMainSiteId.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpnetworkphp"></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/class-wp-network.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-network.php 2017-10-13 21:20:42 UTC (rev 41860)
+++ trunk/src/wp-includes/class-wp-network.php 2017-10-14 22:41:15 UTC (rev 41861)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -148,9 +148,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> case 'id':
</span><span class="cx" style="display: block; padding: 0 10px"> return (int) $this->id;
</span><span class="cx" style="display: block; padding: 0 10px"> case 'blog_id':
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return (string) $this->get_main_site_id();
+ case 'site_id':
</ins><span class="cx" style="display: block; padding: 0 10px"> return $this->get_main_site_id();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- case 'site_id':
- return (int) $this->get_main_site_id();
</del><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"> return null;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -208,16 +208,68 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * properties.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.9.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @see get_main_site_id()
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string Main site ID as numeric string, for compatibility reasons.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return int The ID of the main site.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> private function get_main_site_id() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $this->blog_id ) ) {
- $this->blog_id = (string) get_main_site_id( $this->id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the main site ID.
+ *
+ * Returning a positive integer will effectively short-circuit the function.
+ *
+ * @since 4.9.0
+ *
+ * @param int|null $main_site_id If a positive integer is returned, it is interpreted as the main site ID.
+ * @param int $network_id The ID of the network for which the main site was detected.
+ */
+ $main_site_id = (int) apply_filters( 'pre_get_main_site_id', null, $this->id );
+ if ( 0 < $main_site_id ) {
+ return $main_site_id;
</ins><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">- return $this->blog_id;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 0 < (int) $this->blog_id ) {
+ return (int) $this->blog_id;
+ }
+
+ if ( ( defined( 'DOMAIN_CURRENT_SITE' ) && defined( 'PATH_CURRENT_SITE' ) && $this->domain === DOMAIN_CURRENT_SITE && $this->path === PATH_CURRENT_SITE )
+ || ( defined( 'SITE_ID_CURRENT_SITE' ) && $this->id == SITE_ID_CURRENT_SITE ) ) {
+ if ( defined( 'BLOG_ID_CURRENT_SITE' ) ) {
+ $this->blog_id = (string) BLOG_ID_CURRENT_SITE;
+
+ return (int) $this->blog_id;
+ }
+
+ if ( defined( 'BLOGID_CURRENT_SITE' ) ) { // deprecated.
+ $this->blog_id = (string) BLOGID_CURRENT_SITE;
+
+ return (int) $this->blog_id;
+ }
+ }
+
+ $site = get_site();
+ if ( $site->domain === $this->domain && $site->path === $this->path ) {
+ $main_site_id = (int) $site->id;
+ } else {
+ $cache_key = 'network:' . $this->id . ':main_site';
+
+ $main_site_id = wp_cache_get( $cache_key, 'site-options' );
+ if ( false === $main_site_id ) {
+ $_sites = get_sites( array(
+ 'fields' => 'ids',
+ 'number' => 1,
+ 'domain' => $this->domain,
+ 'path' => $this->path,
+ 'network_id' => $this->id,
+ ) );
+ $main_site_id = ! empty( $_sites ) ? array_shift( $_sites ) : 0;
+
+ wp_cache_add( $cache_key, $main_site_id, 'site-options' );
+ }
+ }
+
+ $this->blog_id = (string) $main_site_id;
+
+ return (int) $this->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></pre></div>
<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 2017-10-13 21:20:42 UTC (rev 41860)
+++ trunk/src/wp-includes/functions.php 2017-10-14 22:41:15 UTC (rev 41861)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4431,51 +4431,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return 0;
</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">- /**
- * Filters the main site ID.
- *
- * Returning anything other than null will effectively short-circuit the function, returning
- * the result parsed as an integer immediately.
- *
- * @since 4.9.0
- *
- * @param int|null $main_site_id If anything other than null is returned, it is interpreted as the main site ID.
- * @param int $network_id The ID of the network for which the main site was detected.
- */
- $main_site_id = apply_filters( 'pre_get_main_site_id', null, $network->id );
- if ( null !== $main_site_id ) {
- return (int) $main_site_id;
- }
-
- if ( ( defined( 'DOMAIN_CURRENT_SITE' ) && defined( 'PATH_CURRENT_SITE' ) && $network->domain === DOMAIN_CURRENT_SITE && $network->path === PATH_CURRENT_SITE )
- || ( defined( 'SITE_ID_CURRENT_SITE' ) && $network->id == SITE_ID_CURRENT_SITE ) ) {
- if ( defined( 'BLOG_ID_CURRENT_SITE' ) ) {
- return BLOG_ID_CURRENT_SITE;
- } elseif ( defined( 'BLOGID_CURRENT_SITE' ) ) { // deprecated.
- return BLOGID_CURRENT_SITE;
- }
- }
-
- $site = get_site();
- if ( $site->domain === $network->domain && $site->path === $network->path ) {
- $main_site_id = (int) $site->id;
- } else {
- $main_site_id = wp_cache_get( 'network:' . $network->id . ':main_site', 'site-options' );
- if ( false === $main_site_id ) {
- $_sites = get_sites( array(
- 'fields' => 'ids',
- 'number' => 1,
- 'domain' => $network->domain,
- 'path' => $network->path,
- 'network_id' => $network->id,
- ) );
- $main_site_id = ! empty( $_sites ) ? array_shift( $_sites ) : 0;
-
- wp_cache_add( 'network:' . $network->id . ':main_site', $main_site_id, 'site-options' );
- }
- }
-
- return (int) $main_site_id;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $network->site_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></pre></div>
<a id="trunktestsphpunittestsmultisitegetMainSiteIdphp"></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/getMainSiteId.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/multisite/getMainSiteId.php 2017-10-13 21:20:42 UTC (rev 41860)
+++ trunk/tests/phpunit/tests/multisite/getMainSiteId.php 2017-10-14 22:41:15 UTC (rev 41861)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -105,6 +105,39 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function filter_get_main_site_id() {
</span><span class="cx" style="display: block; padding: 0 10px"> return 333;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @ticket 41936
+ */
+ public function test_get_main_site_id_with_property_value() {
+ global $current_site;
+
+ $original_main_site_id = $current_site->blog_id;
+ $current_site->blog_id = '123';
+
+ $result = get_main_site_id();
+
+ $current_site->blog_id = $original_main_site_id;
+
+ $this->assertSame( 123, $result );
+ }
+
+ /**
+ * @ticket 41936
+ */
+ public function test_get_main_site_id_filtered_with_property_value() {
+ global $current_site;
+
+ $original_main_site_id = $current_site->blog_id;
+ $current_site->blog_id = '123';
+
+ add_filter( 'pre_get_main_site_id', array( $this, 'filter_get_main_site_id' ) );
+ $result = get_main_site_id();
+
+ $current_site->blog_id = $original_main_site_id;
+
+ $this->assertSame( 333, $result );
+ }
</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"> endif;
</span></span></pre>
</div>
</div>
</body>
</html>