Changeset 54232 for trunk/tests/phpunit/tests/admin/includesSchema.php

Timestamp:

09/20/2022 12:41:58 AM (2 years ago)

Author:

SergeyBiryukov

Message:

Date/Time: Correct sanitization of localized default timezone_string in populate_options().

This fixes a bug where if the default timezone_string is set to a deprecated timezone name due to a localization providing an outdated timezone name string, this localized timezone string would be discarded and an empty string would be set as the timezone value instead.

By passing the DateTimeZone::ALL_WITH_BC constant as the $timezoneGroup parameter to the PHP native timezone_identifiers_list() function, a timezone name list is retrieved containing both current and deprecated timezone names, preventing the invalidation of the option value.

See the extensive write-up about this in ticket #56468.

Also see: ​PHP Manual: timezone_identifiers_list().

Includes:

• Expanding the translators comment to encourage translators to use “old” names over “new” names.
• Adding a dedicated test to the Tests_Admin_IncludesSchema test class.

Follow-up to [54207], [54217], [54227], [54229], [54230].

Props jrf, costdev.
See #56468.

File:

• trunk/tests/phpunit/tests/admin/includesSchema.php (modified) (1 diff)

trunk/tests/phpunit/tests/admin/includesSchema.php

@@ -179 +179 @@
 
     /**
+     * Ensures that deprecated timezone strings set as a default in a translation are handled correctly.
+     *
+     * @ticket 56468
+     */
+    public function test_populate_options_when_locale_uses_deprecated_timezone_string() {
+        global $wpdb;
+
+        // Back up.
+        $orig_options  = $wpdb->options;
+        $wpdb->options = self::$options;
+
+        // Set the "default" value for the timezone to a deprecated timezone.
+        add_filter(
+            'gettext_with_context',
+            static function( $translation, $text, $context ) {
+                if ( '0' === $text && 'default GMT offset or timezone string' === $context ) {
+                    return 'America/Buenos_Aires';
+                }
+
+                return $translation;
+            },
+            10,
+            3
+        );
+
+        // Test.
+        populate_options();
+
+        wp_cache_delete( 'alloptions', 'options' );
+
+        $result = get_option( 'timezone_string' );
+
+        // Reset.
+        $wpdb->query( "TRUNCATE TABLE {$wpdb->options}" );
+        $wpdb->options = $orig_options;
+
+        // Assert.
+        $this->assertSame( 'America/Buenos_Aires', $result );
+    }
+
+    /**
      * @ticket 44896
      * @group multisite