Changeset 45794

Timestamp:

08/14/2019 02:28:52 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Networks and Sites: Improve documentation and variable naming in switch_to_blog() and restore_current_blog().

In switch_to_blog():

• Rename $blog_id to $prev_blog_id for clarity.
• Rename $new_blog to $new_blog_id for consistency.
• Pass $prev_blog_id as a second parameter to switch_blog action, instead of the duplicated $new_blog_id. This only clarifies documentation and does not affect functionality, since the values are equal in the context where the DocBlock is located.

In restore_current_blog():

• Rename $blog to $new_blog_id for clarity.
• Rename $blog_id to $prev_blog_id for clarity.

Props ChriCo, jeremyfelt, SergeyBiryukov.
Fixes #45594.

File:

• trunk/src/wp-includes/ms-blogs.php (modified) (9 diffs)

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

@@ -485 +485 @@
  * @global WP_Object_Cache $wp_object_cache
  *
- * @param int  $new_blog   The id of the blog you want to switch to. Default: current blog
- * @param bool $deprecated Deprecated argument
- * @return true Always returns True.
- */
-function switch_to_blog( $new_blog, $deprecated = null ) {
+ * @param int  $new_blog_id The ID of the blog to switch to. Default: current blog.
+ * @param bool $deprecated  Not used.
+ * @return true Always returns true.
+ */
+function switch_to_blog( $new_blog_id, $deprecated = null ) {
     global $wpdb;
 
-    $blog_id = get_current_blog_id();
-    if ( empty( $new_blog ) ) {
-        $new_blog = $blog_id;
-    }
-
-    $GLOBALS['_wp_switched_stack'][] = $blog_id;
+    $prev_blog_id = get_current_blog_id();
+    if ( empty( $new_blog_id ) ) {
+        $new_blog_id = $prev_blog_id;
+    }
+
+    $GLOBALS['_wp_switched_stack'][] = $prev_blog_id;
 
     /*
@@ -504 +504 @@
      * the extra unnecessary work
      */
-    if ( $new_blog == $blog_id ) {
+    if ( $new_blog_id == $prev_blog_id ) {
         /**
          * Fires when the blog is switched.
@@ -510 +510 @@
          * @since MU (3.0.0)
          *
-         * @param int $new_blog New blog ID.
-         * @param int $new_blog Blog ID.
+         * @param int $new_blog_id  New blog ID.
+         * @param int $prev_blog_id Previous blog ID.
          */
-        do_action( 'switch_blog', $new_blog, $new_blog );
+        do_action( 'switch_blog', $new_blog_id, $prev_blog_id );
         $GLOBALS['switched'] = true;
         return true;
     }
 
-    $wpdb->set_blog_id( $new_blog );
+    $wpdb->set_blog_id( $new_blog_id );
     $GLOBALS['table_prefix'] = $wpdb->get_blog_prefix();
-    $prev_blog_id            = $blog_id;
-    $GLOBALS['blog_id']      = $new_blog;
+    $GLOBALS['blog_id']      = $new_blog_id;
 
     if ( function_exists( 'wp_cache_switch_to_blog' ) ) {
-        wp_cache_switch_to_blog( $new_blog );
+        wp_cache_switch_to_blog( $new_blog_id );
     } else {
         global $wp_object_cache;
@@ -546 +545 @@
 
     /** This filter is documented in wp-includes/ms-blogs.php */
-    do_action( 'switch_blog', $new_blog, $prev_blog_id );
+    do_action( 'switch_blog', $new_blog_id, $prev_blog_id );
     $GLOBALS['switched'] = true;
 
@@ -553 +552 @@
 
 /**
- * Restore the current blog, after calling switch_to_blog()
+ * Restore the current blog, after calling switch_to_blog().
  *
  * @see switch_to_blog()
@@ -565 +564 @@
  * @global WP_Object_Cache $wp_object_cache
  *
- * @return bool True on success, false if we're already on the current blog
+ * @return bool True on success, false if we're already on the current blog.
  */
 function restore_current_blog() {
@@ -574 +573 @@
     }
 
-    $blog    = array_pop( $GLOBALS['_wp_switched_stack'] );
-    $blog_id = get_current_blog_id();
-
-    if ( $blog_id == $blog ) {
+    $new_blog_id  = array_pop( $GLOBALS['_wp_switched_stack'] );
+    $prev_blog_id = get_current_blog_id();
+
+    if ( $new_blog_id == $prev_blog_id ) {
         /** This filter is documented in wp-includes/ms-blogs.php */
-        do_action( 'switch_blog', $blog, $blog );
+        do_action( 'switch_blog', $new_blog_id, $prev_blog_id );
         // If we still have items in the switched stack, consider ourselves still 'switched'
         $GLOBALS['switched'] = ! empty( $GLOBALS['_wp_switched_stack'] );
@@ -585 +584 @@
     }
 
-    $wpdb->set_blog_id( $blog );
-    $prev_blog_id            = $blog_id;
-    $GLOBALS['blog_id']      = $blog;
+    $wpdb->set_blog_id( $new_blog_id );
+    $GLOBALS['blog_id']      = $new_blog_id;
     $GLOBALS['table_prefix'] = $wpdb->get_blog_prefix();
 
     if ( function_exists( 'wp_cache_switch_to_blog' ) ) {
-        wp_cache_switch_to_blog( $blog );
+        wp_cache_switch_to_blog( $new_blog_id );
     } else {
         global $wp_object_cache;
@@ -614 +612 @@
 
     /** This filter is documented in wp-includes/ms-blogs.php */
-    do_action( 'switch_blog', $blog, $prev_blog_id );
+    do_action( 'switch_blog', $new_blog_id, $prev_blog_id );
 
     // If we still have items in the switched stack, consider ourselves still 'switched'