Changeset 6734

Timestamp:

11/16/2017 11:08:24 PM (7 years ago)

Author:

johnjamesjacoby

Message:

Abstraction: abstract site switching functions to include an is_mulitsite() check.

This allows functions that are traditionally hook-only to be called directly, regardless of the installation type, and without littering the codebase with several is_multisite() switches.

Fixes #3179.

Location:

trunk/src/includes

Files:

• admin/actions.php (modified) (1 diff)
• admin/classes/class-bbp-admin.php (modified) (2 diffs)
• admin/common.php (modified) (1 diff)
• core/abstraction.php (modified) (1 diff)
• core/capabilities.php (modified) (1 diff)
• users/capabilities.php (modified) (4 diffs)

trunk/src/includes/admin/actions.php

@@ -143 +143 @@
     }
 
-    // Switch to the new blog
-    switch_to_blog( $blog_id );
+    // Switch to the new site
+    bbp_switch_to_site( $blog_id );
 
     // Do the bbPress activation routine
     do_action( 'bbp_new_site', $blog_id, $user_id, $domain, $path, $site_id, $meta );
 
-    // restore original blog
-    restore_current_blog();
+    // Restore original site
+    bbp_restore_current_site();
 }
 

trunk/src/includes/admin/classes/class-bbp-admin.php

@@ -1136 +1136 @@
                             }
 
-                            // Switch to the new blog
-                            switch_to_blog( $details[ 'blog_id' ] );
+                            // Switch to the new site
+                            bbp_switch_to_site( $details[ 'blog_id' ] );
 
                             $basename = bbpress()->basename;
@@ -1146 +1146 @@
                             }
 
-                            // restore original blog
-                            restore_current_blog();
+                            // Restore original site
+                            bbp_restore_current_site();
 
                             // Do some actions to allow plugins to do things too

trunk/src/includes/admin/common.php

@@ -156 +156 @@
     }
 
-    switch_to_blog( $site_id );
+    bbp_switch_to_site( $site_id );
     bbp_delete_options();
     bbp_remove_roles();
     bbp_remove_caps();
     flush_rewrite_rules();
-    restore_current_blog();
+    bbp_restore_current_site();
 }
 

trunk/src/includes/core/abstraction.php

@@ -335 +335 @@
 }
 
+/**
+ * Switch to a site in a multisite installation.
+ *
+ * If not a multisite installation, no switching will occur.
+ *
+ * @since 2.6.0 bbPress (r6733)
+ *
+ * @param int $site_id
+ */
+function bbp_switch_to_site( $site_id = 0 ) {
+
+    // Switch to a specific site
+    if ( is_multisite() ) {
+        switch_to_blog( $site_id );
+    }
+}
+
+/**
+ * Switch back to the original site in a multisite installation.
+ *
+ * If not a multisite installation, no switching will occur.
+ *
+ * @since 2.6.0 bbPress (r6733)
+ */
+function bbp_restore_current_site( ) {
+
+    // Switch back to the original site
+    if ( is_multisite() ) {
+        restore_current_blog();
+    }
+}
+
 /** Engagements ***************************************************************/
 

trunk/src/includes/core/capabilities.php

@@ -326 +326 @@
  * bbPress does not have an intercept point to add its dynamic roles.
  *
- * @see switch_to_blog()
- * @see restore_current_blog()
+ * @see bbp_switch_to_site()
+ * @see bbp_restore_current_site()
  * @see WP_Roles::_init()
  *

trunk/src/includes/users/capabilities.php

@@ -492 +492 @@
     foreach ( (array) array_keys( $blogs ) as $blog_id ) {
 
-        // Switch to the blog ID
-        switch_to_blog( $blog_id );
+        // Switch to the site ID
+        bbp_switch_to_site( $blog_id );
 
         // Get topics and replies
@@ -518 +518 @@
         }
 
-        // Switch back to current blog
-        restore_current_blog();
+        // Switch back to current site
+        bbp_restore_current_site();
     }
 
@@ -570 +570 @@
     foreach ( (array) array_keys( $blogs ) as $blog_id ) {
 
-        // Switch to the blog ID
-        switch_to_blog( $blog_id );
+        // Switch to the site ID
+        bbp_switch_to_site( $blog_id );
 
         // Get topics and replies
@@ -596 +596 @@
         }
 
-        // Switch back to current blog
-        restore_current_blog();
+        // Switch back to current site
+        bbp_restore_current_site();
     }