Changeset 32775

Timestamp:

06/14/2015 09:44:45 PM (8 years ago)

Author:

jeremyfelt

Message:

Introduce get_main_network_id()

Expand on the logic previously available as part of is_main_network() and provide a way to obtain the ID of the main network. Most useful in multi-network configurations.

Props @johnjamesjacoby for the initial patch.
Fixes #30294.

Location:

trunk

Files:

• src/wp-includes/functions.php (modified) (1 diff)
• tests/phpunit/tests/multisite/network.php (modified) (1 diff)

trunk/src/wp-includes/functions.php

@@ -3874 +3874 @@
  * @since 3.7.0
  *
- * @global wpdb $wpdb
- *
  * @param int $network_id Optional. Network ID to test. Defaults to current network.
  * @return bool True if $network_id is the main network, or if not running Multisite.
  */
 function is_main_network( $network_id = null ) {
+    if ( ! is_multisite() ) {
+        return true;
+    }
+
+    $current_network_id = (int) get_current_site()->id;
+
+    if ( null === $network_id ) {
+        $network_id = $current_network_id;
+    }
+
+    $network_id = (int) $network_id;
+
+    return ( $network_id === get_main_network_id() );
+}
+
+/**
+ * Get the main network ID.
+ *
+ * @since 4.3.0
+ *
+ * @global wpdb $wpdb
+ *
+ * @return int The ID of the main network.
+ */
+function get_main_network_id() {
     global $wpdb;
 
-    if ( ! is_multisite() )
-        return true;
-
-    $current_network_id = (int) get_current_site()->id;
-
-    if ( ! $network_id )
-        $network_id = $current_network_id;
-    $network_id = (int) $network_id;
-
-    if ( defined( 'PRIMARY_NETWORK_ID' ) )
-        return $network_id === (int) PRIMARY_NETWORK_ID;
-
-    if ( 1 === $current_network_id )
-        return $network_id === $current_network_id;
-
-    $primary_network_id = (int) wp_cache_get( 'primary_network_id', 'site-options' );
-
-    if ( $primary_network_id )
-        return $network_id === $primary_network_id;
-
-    $primary_network_id = (int) $wpdb->get_var( "SELECT id FROM $wpdb->site ORDER BY id LIMIT 1" );
-    wp_cache_add( 'primary_network_id', $primary_network_id, 'site-options' );
-
-    return $network_id === $primary_network_id;
+    if ( ! is_multisite() ) {
+        return 1;
+    }
+
+    if ( defined( 'PRIMARY_NETWORK_ID' ) ) {
+        $main_network_id = PRIMARY_NETWORK_ID;
+    } elseif ( 1 === (int) get_current_site()->id ) {
+        // If the current network has an ID of 1, assume it is the main network.
+        $main_network_id = 1;
+    } else {
+        $main_network_id = wp_cache_get( 'primary_network_id', 'site-options' );
+
+        if ( false === $main_network_id ) {
+            $main_network_id = (int) $wpdb->get_var( "SELECT id FROM {$wpdb->site} ORDER BY id LIMIT 1" );
+            wp_cache_add( 'primary_network_id', $main_network_id, 'site-options' );
+        }
+    }
+
+    /**
+     * Filter the main network ID.
+     *
+     * @since 4.3.0
+     *
+     * @param int $main_network_id The ID of the main network.
+     */
+    return (int) apply_filters( 'get_main_network_id', $main_network_id );
 }
 

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

@@ -22 +22 @@
 
     function tearDown() {
-        global $wpdb;
+        global $wpdb, $current_site;
         $wpdb->suppress_errors( $this->suppress );
+        $current_site->id = 1;
         parent::tearDown();
+    }
+
+    /**
+     * By default, only one network exists and has a network ID of 1.
+     */
+    function test_get_main_network_id_default() {
+        $this->assertEquals( 1, get_main_network_id() );
+    }
+
+    /**
+     * If a second network is created, network ID 1 should still be returned
+     * as the main network ID.
+     */
+    function test_get_main_network_id_two_networks() {
+        $this->factory->network->create();
+
+        $this->assertEquals( 1, get_main_network_id() );
+    }
+
+    /**
+     * When the `$current_site` global is populated with another network, the
+     * main network should still return as 1.
+     */
+    function test_get_main_network_id_after_network_switch() {
+        global $current_site;
+
+        $id = $this->factory->network->create();
+
+        $current_site->id = (int) $id;
+
+        $this->assertEquals( 1, get_main_network_id() );
+    }
+
+    /**
+     * When the first network is removed, the next should return as the main
+     * network ID.
+     *
+     * @todo In the future, we'll have a smarter way of deleting a network. For now,
+     * fake the process with UPDATE queries.
+     */
+    function test_get_main_network_id_after_network_delete() {
+        global $wpdb, $current_site;
+        $id = $this->factory->network->create();
+
+        $current_site->id = (int) $id;
+        $wpdb->query( "UPDATE {$wpdb->site} SET id=100 WHERE id=1" );
+        $this->assertEquals( $id, get_main_network_id() );
+        $wpdb->query( "UPDATE {$wpdb->site} SET id=1 WHERE id=100" );
+    }
+
+    function test_get_main_network_id_filtered() {
+        add_filter( 'get_main_network_id', array( $this, '_get_main_network_id' ) );
+        $this->assertEquals( 3, get_main_network_id() );
+        remove_filter( 'get_main_network_id', array( $this, '_get_main_network_id' ) );
+    }
+
+    function _get_main_network_id() {
+        return 3;
     }