Changeset 47105

Timestamp:

01/22/2020 08:51:26 PM (7 years ago)

Author:

iandunn

Message:

Multisite: Add $context parameter to switch_blog action.

The action is fired by both switch_to_blog() and restore_current_blog(), and previously it was difficult for callback functions to determine which function had fired it.

Props SergeyBiryukov, johnbillion, jeremyfelt.
Fixes #49265.

File:

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

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

@@ -509 +509 @@
                  *
                  * @since MU (3.0.0)
+                 * @since 5.4.0 The `$context` parameter was added.
                  *
-                 * @param int $new_blog_id  New blog ID.
-                 * @param int $prev_blog_id Previous blog ID.
+                 * @param int    $new_blog_id  New blog ID.
+                 * @param int    $prev_blog_id Previous blog ID.
+                 * @param string $context      Additional context. Accepts 'switch' when called from switch_to_blog()
+                 *                             or 'restore' when called from restore_current_blog().
                  */
-                do_action( 'switch_blog', $new_blog_id, $prev_blog_id );
+                do_action( 'switch_blog', $new_blog_id, $prev_blog_id, 'switch' );
                 $GLOBALS['switched'] = true;
                 return true;
@@ -545 +548 @@
 
         /** This filter is documented in wp-includes/ms-blogs.php */
-        do_action( 'switch_blog', $new_blog_id, $prev_blog_id );
+        do_action( 'switch_blog', $new_blog_id, $prev_blog_id, 'switch' );
         $GLOBALS['switched'] = true;
 
@@ -578 +581 @@
         if ( $new_blog_id == $prev_blog_id ) {
                 /** This filter is documented in wp-includes/ms-blogs.php */
-                do_action( 'switch_blog', $new_blog_id, $prev_blog_id );
+                do_action( 'switch_blog', $new_blog_id, $prev_blog_id, 'restore' );
                 // If we still have items in the switched stack, consider ourselves still 'switched'
                 $GLOBALS['switched'] = ! empty( $GLOBALS['_wp_switched_stack'] );
@@ -612 +615 @@
 
         /** This filter is documented in wp-includes/ms-blogs.php */
-        do_action( 'switch_blog', $new_blog_id, $prev_blog_id );
+        do_action( 'switch_blog', $new_blog_id, $prev_blog_id, 'restore' );
 
         // If we still have items in the switched stack, consider ourselves still 'switched'