Ticket #49263: 49263.4.diff

src/wp-includes/l10n.php

@@ -28 +28 @@
  * @return string The locale of the blog or from the {@see 'locale'} hook.
  */
 function get_locale() {
-        global $locale, $wp_local_package;
+        global $locale;
 
         if ( isset( $locale ) ) {
                 /**
@@ -41 +41 @@
                 return apply_filters( 'locale', $locale );
         }
 
+        $locale = _get_raw_site_locale();
+
+        /** This filter is documented in wp-includes/l10n.php */
+        return apply_filters( 'locale', $locale );
+}
+
+// todo explain internal and should not be used by plugins?
+// or let it be external? no harm?
+function _get_raw_site_locale() {
+        global $wp_local_package;
+
         if ( isset( $wp_local_package ) ) {
                 $locale = $wp_local_package;
         }
@@ -57 +68 @@
                         $ms_locale = get_site_option( 'WPLANG' );
                 } else {
                         $ms_locale = get_option( 'WPLANG' );
+
                         if ( false === $ms_locale ) {
                                 $ms_locale = get_site_option( 'WPLANG' );
                         }
@@ -65 +77 @@
                 if ( $ms_locale !== false ) {
                         $locale = $ms_locale;
                 }
+
         } else {
                 $db_locale = get_option( 'WPLANG' );
+
                 if ( $db_locale !== false ) {
                         $locale = $db_locale;
                 }
@@ -76 +90 @@
                 $locale = 'en_US';
         }
 
-        /** This filter is documented in wp-includes/l10n.php */
-        return apply_filters( 'locale', $locale );
+        return $locale;
 }
 
 /**

src/wp-includes/ms-blogs.php

@@ -486 +486 @@
  *
  * @param int  $new_blog_id The ID of the blog to switch to. Default: current blog.
  * @param bool $deprecated  Not used.
+ * @param what to name it?
  * @return true Always returns true.
  */
-function switch_to_blog( $new_blog_id, $deprecated = null ) {
+function switch_to_blog( $new_blog_id, $deprecated = null, $options = array() ) {
         global $wpdb;
 
+        // what did deprecated arg use to be? why isn't there a _deprecated_parametr() call here?
+                // https://core.trac.wordpress.org/changeset/21485
+        // if it used to be an int or something, then could do something like
+        // if ! array then deprecated_paramters()
+
+        // if pass in bool, then depreated warning
+        // else, convert to array to make sure
+        // or maybe just if they pass in anything besides an array?
+        // search plugin dir to get rough idea of current usage
+                // ag "switch_to_blog\(\s?(.*)," --php ./plugins/ | tee scans/switch-to-blog.txt
+                //> cat scans/switch-to-blog.txt |grep -v "freemius" > scans/switch-to-blog-not-freemius.txt
+
+        // better name - flags? switches? what_to_switch? there's gotta be something more descriptive
+
+        $default_options = array(
+                'blog_id'      => true, // any valid use case for this being false?
+                'table_prefix' => true, // any valid use case for this being false?
+                'object_cache' => true,
+                'locale'       => false,
+        );
+
+        // add filter for default options too?
+
+        // document filter
+        $options = apply_filters(
+                'switch_blog_options',
+                wp_parse_args( $options, $default_options )
+        );
+
+        // add conditions around everything based on existing options
+                // er, that may be getting out of scope for this ticket
+                // maybe just do locale for this ticket, and then open new ticket to add additional options
+
         $prev_blog_id = get_current_blog_id();
         if ( empty( $new_blog_id ) ) {
                 $new_blog_id = $prev_blog_id;
@@ -514 +548 @@
                  * @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().
+                 * @param array $optons        explain
                  */
-                do_action( 'switch_blog', $new_blog_id, $prev_blog_id, 'switch' );
+                do_action( 'switch_blog', $new_blog_id, $prev_blog_id, 'switch', $options );
                 $GLOBALS['switched'] = true;
                 return true;
         }
@@ -546 +581 @@
                 }
         }
 
+        $switcher_initialized = isset( $GLOBALS['wp_locale_switcher'] );
+                // also check $GLOBALS['wp_locale_switcher'] instanceof WP_Locale_Switcher ?
+                // make DRY w/ restore_current_blog()
+
+        if ( true === $options['locale'] && $switcher_initialized ) {
+                $new_locale = _get_raw_site_locale();
+                switch_to_locale( $new_locale );
+        }
+
         /** This filter is documented in wp-includes/ms-blogs.php */
-        do_action( 'switch_blog', $new_blog_id, $prev_blog_id, 'switch' );
+        do_action( 'switch_blog', $new_blog_id, $prev_blog_id, 'switch', $options );
         $GLOBALS['switched'] = true;
 
         return true;
@@ -613 +657 @@
                 }
         }
 
+        $should_restore = true;
+                // how to determine? always true? only if the corresponding switch_to_blog() call passed locale=>true ? any other concerns?
+                // or just automatically restonre what the last switch enabled, but do automatically w/out asking ?
+        $switcher_initialized = isset( $GLOBALS['wp_locale_switcher'] );
+                // also check $GLOBALS['wp_locale_switcher'] instanceof WP_Locale_Switcher ?
+
+        if ( $should_restore && $switcher_initialized ) {
+                if ( is_locale_switched() ) {
+                        // ^ probably isn't good enough, b/c that only checks if the locale has been switched, NOT if it was switched by the corresponding switch_to_blog() call
+                                // could be situations where there are nested blog switches, and sometimes locale is switched and sometimes it's not
+                                // so i think this could pop a locale off the stack when it shouldn't
+                                // add a unit test for that situation
+                        // what's an elegant solution to that?
+                                // maybe need to track it in a global or something? hopefully there's a better way
+                        restore_current_locale();
+                }
+        }
+
         /** This filter is documented in wp-includes/ms-blogs.php */
         do_action( 'switch_blog', $new_blog_id, $prev_blog_id, 'restore' );
 

tests/phpunit/tests/multisite/site.php

@@ -133 +133 @@
                         $this->assertFalse( restore_current_blog() );
                 }
 
+                /**
+                 *
+                 * look up guidelines for phpdoc etc
+                 *
+                 * @dataProvider data_switch_blog_locale
+                 *
+                 * @covers switch_to_blog
+                 *
+                 *                       'blog_id'                     => $japanese_blog_id,
+                                        'get_locale_options'          => array(),
+                                        'expected_raw_site_locale'    => 'ja_JP',
+                                        'expected_cached_site_locale' => 'en_US',
+                 */
+                function test_switch_blog_locale( $switch_blog_id, $switch_blog_arguments, $expected_raw_locale, $expected_cached_locale ) {
+                        // Make sure starting assumptions are correct.
+                        $this->assertTrue( is_main_site() );
+                        $this->assertEquals( 'en_US', _get_raw_site_locale() );
+                        $this->assertEquals( 'en_US', get_locale() );
+
+                        // Make sure switched properly.
+                        switch_to_blog( $switch_blog_id, null, $switch_blog_arguments );
+                        $this->assertEquals( $expected_raw_locale, _get_raw_site_locale() );
+                        $this->assertEquals( $expected_cached_locale, get_locale() );
+                        restore_current_blog();
+
+                        // Make sure restored properly.
+                                // thss is probably redundant b/c will be checked on the next call, so can probably remove this
+                        $this->assertTrue( is_main_site() );
+                        $this->assertEquals( 'en_US', _get_raw_site_locale() );
+                        $this->assertEquals( 'en_US', get_locale() );
+
+
+                        // test actually translating a string everywhere?
+                        // test during installation? at least manually
+                }
+
+                /**
+                 * Data provider for
+                 *
+                 *
+                 * list args here maybe
+                 */
+                function data_switch_blog_locale() {
+                        $japanese_blog_id = self::factory()->blog->create(
+                                array(
+                                        'options' => array( 'WPLANG' => 'ja_JP' ),
+                                )
+                        );
+                        // should create ^ in class setUp()? but only used for this one function. function gets called many times though
+                        // maybe create in test_switch_blog_locale, but then how to put id in provided data down here?
+
+                        // also create a german blog so can test non-english -> non-english
+
+
+                        // identify the bug you're seeing in mu-plugin tests, and test for that here
+
+
+                        $cases = array(
+                                // Default behavior, locale not switched
+                                array(
+                                        'blog_id'                     => $japanese_blog_id,
+                                        'get_locale_options'          => array(),
+                                        'expected_raw_site_locale'    => 'ja_JP',
+                                        'expected_cached_site_locale' => 'en_US',
+                                ),
+
+                                // Switch the locale
+                                array(
+                                        'blog_id'                     => $japanese_blog_id,
+                                        'get_locale_options'          => array( 'locale' => true ),
+                                        'expected_raw_site_locale'    => 'ja_JP',
+                                        'expected_cached_site_locale' => 'ja_JP',
+                                ),
+                        );
+
+                        // test switching english -> nonenglish, non-english->english, nonenglish -> nonenglish
+
+                        // programatically copy all those tests and repeat them w/ user locale enabled
+
+                        return $cases;
+                }
+
                 /**
                  * Test the cache keys and database tables setup through the creation of a site.
                  */