Changeset 41380

Timestamp:

09/15/2017 11:14:49 AM (9 years ago)

Author:

flixos90

Message:

Multisite: Introduce get_main_site_id().

This function can be used to easily get the main site ID of a given network via the optional $network_id parameter, which defaults to the current network. The existing is_main_site() now uses the new function internally and now accepts an optional $network_id parameter as well.

The main purpose of the new function at this point is to ensure that the WP_Network::$blog_id property is always set. Magic getters in the class have been adjusted to auto-fill the property when it is accessed and empty. Furthermore the function encapsulates logic that was previously part of ms_load_current_site_and_network() and has been replaced with a call to the function now.

Props spacedmonkey, jeremyfelt, johnjamesjacoby, flixos90.
Fixes #29684.

Location:

trunk

Files:

• src/wp-includes/class-wp-network.php (modified) (2 diffs)
• src/wp-includes/functions.php (modified) (1 diff)
• src/wp-includes/ms-load.php (modified) (2 diffs)
• tests/phpunit/tests/multisite/getMainSiteId.php (added)
• tests/phpunit/tests/multisite/network.php (modified) (1 diff)
• tests/phpunit/tests/multisite/site.php (modified) (3 diffs)

trunk/src/wp-includes/class-wp-network.php

@@ -149 +149 @@
                                 return (int) $this->id;
                         case 'blog_id':
-                                return $this->blog_id;
+                                return $this->get_main_site_id();
                         case 'site_id':
-                                return (int) $this->blog_id;
+                                return (int) $this->get_main_site_id();
                 }
 
@@ -200 +200 @@
                                 $this->$key = $value;
                 }
+        }
+
+        /**
+         * Returns the main site ID for the network.
+         *
+         * Internal method used by the magic getter for the 'blog_id' and 'site_id'
+         * properties.
+         *
+         * @since 4.9.0
+         * @see get_main_site_id()
+         *
+         * @return string Main site ID as numeric string, for compatibility reasons.
+         */
+        private function get_main_site_id() {
+                if ( empty( $this->blog_id ) ) {
+                        $this->blog_id = (string) get_main_site_id( $this->id );
+                }
+
+                return $this->blog_id;
         }
 

trunk/src/wp-includes/functions.php

@@ -4391 +4391 @@
  *
  * @since 3.0.0
- *
- * @param int $site_id Optional. Site ID to test. Defaults to current site.
+ * @since 4.9.0 The $network_id parameter has been added.
+ *
+ * @param int $site_id    Optional. Site ID to test. Defaults to current site.
+ * @param int $network_id Optional. Network ID of the network to check for.
+ *                        Defaults to current network.
  * @return bool True if $site_id is the main site of the network, or if not
  *              running Multisite.
  */
-function is_main_site( $site_id = null ) {
-        if ( ! is_multisite() )
+function is_main_site( $site_id = null, $network_id = null ) {
+        if ( ! is_multisite() ) {
                 return true;
-
-        if ( ! $site_id )
+        }
+
+        if ( ! $site_id ) {
                 $site_id = get_current_blog_id();
-
-        return (int) $site_id === (int) get_network()->site_id;
+        }
+
+        $site_id = (int) $site_id;
+
+        return $site_id === get_main_site_id( $network_id );
+}
+
+/**
+ * Gets the main site ID.
+ *
+ * @since 4.9.0
+ *
+ * @param int $network_id Optional. The ID of the network for which to get the main site.
+ *                        Defaults to the current network.
+ * @return int The ID of the main site.
+ */
+function get_main_site_id( $network_id = null ) {
+        if ( ! is_multisite() ) {
+                return 1;
+        }
+
+        $network = get_network( $network_id );
+        if ( ! $network ) {
+                return 0;
+        }
+
+        /**
+         * 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;
 }
 

trunk/src/wp-includes/ms-load.php

@@ -136 +136 @@
 /**
  * Retrieves the closest matching site object by its domain and path.
- * 
+ *
  * This will not necessarily return an exact match for a domain and path. Instead, it
  * breaks the domain and path into pieces that are then used to match the closest
@@ -425 +425 @@
         // Figure out the current network's main site.
         if ( empty( $current_site->blog_id ) ) {
-                if ( $current_blog->domain === $current_site->domain && $current_blog->path === $current_site->path ) {
-                        $current_site->blog_id = $current_blog->blog_id;
-                } elseif ( ! $current_site->blog_id = wp_cache_get( 'network:' . $current_site->id . ':main_site', 'site-options' ) ) {
-                        $current_site->blog_id = $wpdb->get_var( $wpdb->prepare( "SELECT blog_id FROM $wpdb->blogs WHERE domain = %s AND path = %s",
-                                $current_site->domain, $current_site->path ) );
-                        wp_cache_add( 'network:' . $current_site->id . ':main_site', $current_site->blog_id, 'site-options' );
-                }
+                $current_site->blog_id = get_main_site_id( $current_site->id );
         }
 

trunk/tests/phpunit/tests/multisite/network.php

@@ -584 +584 @@
                 $this->assertEquals( $original_count + 1, $result );
         }
+
+        /**
+         * @ticket 29684
+         */
+        public function test_network_blog_id_set() {
+                $network = get_network( self::$different_network_id );
+
+                $this->assertSame( (string) self::$different_site_ids[0], $network->blog_id );
+        }
 }
 

trunk/tests/phpunit/tests/multisite/site.php

@@ -12 +12 @@
         protected $suppress = false;
         protected static $network_ids;
+        protected static $site_ids;
 
         function setUp() {
@@ -34 +35 @@
                 }
                 unset( $id );
+
+                self::$site_ids = array(
+                        'make.wordpress.org/'     => array( 'domain' => 'make.wordpress.org', 'path' => '/',         'site_id' => self::$network_ids['make.wordpress.org/'] ),
+                        'make.wordpress.org/foo/' => array( 'domain' => 'make.wordpress.org', 'path' => '/foo/',     'site_id' => self::$network_ids['make.wordpress.org/'] ),
+                );
+
+                foreach ( self::$site_ids as &$id ) {
+                        $id = $factory->blog->create( $id );
+                }
+                unset( $id );
         }
 
         public static function wpTearDownAfterClass() {
                 global $wpdb;
+
+                foreach( self::$site_ids as $id ) {
+                        wpmu_delete_blog( $id, true );
+                }
 
                 foreach( self::$network_ids as $id ) {
@@ -1029 +1044 @@
                 return $original_value;
         }
+
+        /**
+         * @ticket 29684
+         */
+        public function test_is_main_site_different_network() {
+                $this->assertTrue( is_main_site( self::$site_ids['make.wordpress.org/'], self::$network_ids['make.wordpress.org/'] ) );
+        }
+
+        /**
+         * @ticket 29684
+         */
+        public function test_is_main_site_different_network_random_site() {
+                $this->assertFalse( is_main_site( self::$site_ids['make.wordpress.org/foo/'], self::$network_ids['make.wordpress.org/'] ) );
+        }
 }