Changeset 43389

Timestamp:

07/04/2018 11:42:59 PM (6 years ago)

Author:

flixos90

Message:

Date/Time: Fix usage of $gmt parameter in date_i18n() and clarify its behavior.

The docs for date_i18n() and its filter now correctly state that the $gmt parameter is only taken into account if no timestamp is provided. Furthermore, a bug with that parameter is fixed, as it is now ensured that the timezone used with it is UTC.

Props Rarst.
Fixes #38771.

Location:

trunk

Files:

• src/wp-includes/functions.php (modified) (3 diffs)
• tests/phpunit/tests/date/dateI18n.php (modified) (2 diffs)

trunk/src/wp-includes/functions.php

@@ -89 +89 @@
  * @param int|bool $timestamp_with_offset Optional. A sum of Unix timestamp and timezone offset in seconds.
  *                                        Default false.
- * @param bool     $gmt                   Optional. Whether to use GMT timezone. Default false.
+ * @param bool     $gmt                   Optional. Whether to use GMT timezone. Only applies if timestamp is
+ *                                        not provided. Default false.
  *
  * @return string The date, translated if locale specifies it.
@@ -128 +129 @@
     if ( preg_match( "/$timezone_formats_re/", $dateformatstring ) ) {
         $timezone_string = get_option( 'timezone_string' );
+        if ( false === $timestamp_with_offset && $gmt ) {
+            $timezone_string = 'UTC';
+        }
         if ( $timezone_string ) {
             $timezone_object = timezone_open( $timezone_string );
@@ -181 +185 @@
      * @param string $req_format Format to display the date.
      * @param int    $i          A sum of Unix timestamp and timezone offset in seconds.
-     * @param bool   $gmt        Whether to convert to GMT for time. Default false.
+     * @param bool   $gmt        Whether to use GMT timezone. Only applies if timestamp was
+     *                           not provided. Default false.
      */
     $j = apply_filters( 'date_i18n', $j, $req_format, $i, $gmt );

trunk/tests/phpunit/tests/date/dateI18n.php

@@ -15 +15 @@
 
     public function test_date_should_be_in_gmt() {
-        $this->assertEquals( strtotime( date( 'Y-m-d H:i:s' ) ), strtotime( date_i18n( 'Y-m-d H:i:s', false, true ) ), 'The dates should be equal', 2 );
+        $this->assertEquals( strtotime( date( DATE_RFC3339 ) ), strtotime( date_i18n( DATE_RFC3339, false, true ) ), 'The dates should be equal', 2 );
     }
 
@@ -31 +31 @@
         update_option( 'timezone_string', 'America/Regina' );
 
-        $this->assertEquals( strtotime( date( 'Y-m-d H:i:s' ) ), strtotime( date_i18n( 'Y-m-d H:i:s', false, true ) ), 'The dates should be equal', 2 );
+        $this->assertEquals( strtotime( date( DATE_RFC3339 ) ), strtotime( date_i18n( DATE_RFC3339, false, true ) ), 'The dates should be equal', 2 );
     }