<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[45887] trunk: Date/Time: Rewrite and simplify `get_gmt_from_date()`, `get_date_from_gmt()`, and `iso8601_to_datetime()` using `wp_timezone()`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/45887">45887</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/45887","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-08-23 11:02:51 +0000 (Fri, 23 Aug 2019)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Date/Time: Rewrite and simplify `get_gmt_from_date()`, `get_date_from_gmt()`, and `iso8601_to_datetime()` using `wp_timezone()`.
Improve unit test coverage.
Props Rarst, goodevilgenius.
Fixes <a href="https://core.trac.wordpress.org/ticket/31809">#31809</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesformattingphp">trunk/src/wp-includes/formatting.php</a></li>
<li><a href="#trunktestsphpunittestsformattingdatephp">trunk/tests/phpunit/tests/formatting/date.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesformattingphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/formatting.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/formatting.php 2019-08-23 02:14:07 UTC (rev 45886)
+++ trunk/src/wp-includes/formatting.php 2019-08-23 11:02:51 UTC (rev 45887)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3384,71 +3384,45 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Returns a date in the GMT equivalent.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Requires and returns a date in the Y-m-d H:i:s format. If there is a
- * timezone_string available, the date is assumed to be in that timezone,
- * otherwise it simply subtracts the value of the 'gmt_offset' option. Return
- * format can be overridden using the $format parameter.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Requires and returns a date in the Y-m-d H:i:s format.
+ * Return format can be overridden using the $format parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $string The date to be converted.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $format The format string for the returned date (default is Y-m-d H:i:s)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $format The format string for the returned date. Default 'Y-m-d H:i:s'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string GMT version of the date provided.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_gmt_from_date( $string, $format = 'Y-m-d H:i:s' ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $tz = get_option( 'timezone_string' );
- if ( $tz ) {
- $datetime = date_create( $string, new DateTimeZone( $tz ) );
- if ( ! $datetime ) {
- return gmdate( $format, 0 );
- }
- $datetime->setTimezone( new DateTimeZone( 'UTC' ) );
- $string_gmt = $datetime->format( $format );
- } else {
- if ( ! preg_match( '#([0-9]{1,4})-([0-9]{1,2})-([0-9]{1,2}) ([0-9]{1,2}):([0-9]{1,2}):([0-9]{1,2})#', $string, $matches ) ) {
- $datetime = strtotime( $string );
- if ( false === $datetime ) {
- return gmdate( $format, 0 );
- }
- return gmdate( $format, $datetime );
- }
- $string_time = gmmktime( $matches[4], $matches[5], $matches[6], $matches[2], $matches[3], $matches[1] );
- $string_gmt = gmdate( $format, $string_time - get_option( 'gmt_offset' ) * HOUR_IN_SECONDS );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $datetime = date_create( $string, wp_timezone() );
+
+ if ( false === $datetime ) {
+ return gmdate( $format, 0 );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $string_gmt;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ return $datetime->setTimezone( new DateTimeZone( 'UTC' ) )->format( $format );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Converts a GMT date into the correct format for the blog.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Requires and returns a date in the Y-m-d H:i:s format. If there is a
- * timezone_string available, the returned date is in that timezone, otherwise
- * it simply adds the value of gmt_offset. Return format can be overridden
- * using the $format parameter
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Requires and returns a date in the Y-m-d H:i:s format.
+ * Return format can be overridden using the $format parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $string The date to be converted.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $format The format string for the returned date (default is Y-m-d H:i:s)
- * @return string Formatted date relative to the timezone / GMT offset.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $format The format string for the returned date. Default 'Y-m-d H:i:s'.
+ * @return string Formatted date relative to the timezone.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_date_from_gmt( $string, $format = 'Y-m-d H:i:s' ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $tz = get_option( 'timezone_string' );
- if ( $tz ) {
- $datetime = date_create( $string, new DateTimeZone( 'UTC' ) );
- if ( ! $datetime ) {
- return gmdate( $format, 0 );
- }
- $datetime->setTimezone( new DateTimeZone( $tz ) );
- $string_localtime = $datetime->format( $format );
- } else {
- if ( ! preg_match( '#([0-9]{1,4})-([0-9]{1,2})-([0-9]{1,2}) ([0-9]{1,2}):([0-9]{1,2}):([0-9]{1,2})#', $string, $matches ) ) {
- return gmdate( $format, 0 );
- }
- $string_time = gmmktime( $matches[4], $matches[5], $matches[6], $matches[2], $matches[3], $matches[1] );
- $string_localtime = gmdate( $format, $string_time + get_option( 'gmt_offset' ) * HOUR_IN_SECONDS );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $datetime = date_create( $string, new DateTimeZone( 'UTC' ) );
+
+ if ( false === $datetime ) {
+ return gmdate( $format, 0 );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $string_localtime;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ return $datetime->setTimezone( wp_timezone() )->format( $format );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3473,35 +3447,32 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Converts an iso8601 date to MySQL DateTime format used by post_date[_gmt].
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Converts an iso8601 (Ymd\TH:i:sO) date to MySQL DateTime (Y-m-d H:i:s) format used by post_date[_gmt].
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $date_string Date and time in ISO 8601 format {@link https://en.wikipedia.org/wiki/ISO_8601}.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $timezone Optional. If set to GMT returns the time minus gmt_offset. Default is 'user'.
- * @return string The date and time in MySQL DateTime format - Y-m-d H:i:s.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $timezone Optional. If set to 'gmt' returns the result in UTC. Default 'user'.
+ * @return string|bool The date and time in MySQL DateTime format - Y-m-d H:i:s, or false on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function iso8601_to_datetime( $date_string, $timezone = 'user' ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $timezone = strtolower( $timezone );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $timezone = strtolower( $timezone );
+ $wp_timezone = wp_timezone();
+ $datetime = date_create( $date_string, $wp_timezone ); // Timezone is ignored if input has one.
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $timezone == 'gmt' ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( false === $datetime ) {
+ return false;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- preg_match( '#([0-9]{4})([0-9]{2})([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})(Z|[\+|\-][0-9]{2,4}){0,1}#', $date_string, $date_bits );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'gmt' === $timezone ) {
+ return $datetime->setTimezone( new DateTimeZone( 'UTC' ) )->format( 'Y-m-d H:i:s' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! empty( $date_bits[7] ) ) { // we have a timezone, so let's compute an offset
- $offset = iso8601_timezone_to_offset( $date_bits[7] );
- } else { // we don't have a timezone, so we assume user local timezone (not server's!)
- $offset = HOUR_IN_SECONDS * get_option( 'gmt_offset' );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'user' === $timezone ) {
+ return $datetime->setTimezone( $wp_timezone )->format( 'Y-m-d H:i:s' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $timestamp = gmmktime( $date_bits[4], $date_bits[5], $date_bits[6], $date_bits[2], $date_bits[3], $date_bits[1] );
- $timestamp -= $offset;
-
- return gmdate( 'Y-m-d H:i:s', $timestamp );
-
- } elseif ( $timezone == 'user' ) {
- return preg_replace( '#([0-9]{4})([0-9]{2})([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})(Z|[\+|\-][0-9]{2,4}){0,1}#', '$1-$2-$3 $4:$5:$6', $date_string );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return false;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunktestsphpunittestsformattingdatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/formatting/date.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/formatting/date.php 2019-08-23 02:14:07 UTC (rev 45886)
+++ trunk/tests/phpunit/tests/formatting/date.php 2019-08-23 11:02:51 UTC (rev 45887)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -96,4 +96,114 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $gmt = gmdate( 'Y-m-d H:i:s' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( strtotime( $gmt ), strtotime( get_gmt_from_date( $local ) ), 'The dates should be equal', 2 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @ticket 31809
+ *
+ * @dataProvider timezone_provider
+ */
+ public function test_gmt_from_date_correct_time( $timezone_string, $gmt_offset ) {
+ update_option( 'timezone_string', $timezone_string );
+ update_option( 'gmt_offset', $gmt_offset );
+
+ $local = new DateTimeImmutable( 'now', wp_timezone() );
+ $utc = $local->setTimezone( new DateTimeZone( 'UTC' ) );
+ $mysql_local = $local->format( 'Y-m-d H:i:s' );
+
+ $this->assertEquals( $utc->format( DATE_RFC3339 ), get_gmt_from_date( $mysql_local, DATE_RFC3339 ) );
+ }
+
+ /**
+ * @ticket 31809
+ *
+ * @dataProvider timezone_provider
+ */
+ public function test_date_from_gmt_correct_time( $timezone_string, $gmt_offset ) {
+ update_option( 'timezone_string', $timezone_string );
+ update_option( 'gmt_offset', $gmt_offset );
+
+ $local = new DateTimeImmutable( 'now', wp_timezone() );
+ $utc = $local->setTimezone( new DateTimeZone( 'UTC' ) );
+ $mysql_utc = $utc->format( 'Y-m-d H:i:s' );
+
+ $this->assertEquals( $local->format( DATE_RFC3339 ), get_date_from_gmt( $mysql_utc, DATE_RFC3339 ) );
+ }
+
+ /**
+ * @ticket 31809
+ *
+ * @dataProvider timezone_provider
+ */
+ public function test_is8601_to_datetime_correct_time( $timezone_string, $gmt_offset ) {
+ update_option( 'timezone_string', $timezone_string );
+ update_option( 'gmt_offset', $gmt_offset );
+
+ $format = 'Ymd\TH:i:sO';
+ $format_no_tz = 'Ymd\TH:i:s';
+
+ $local = new DateTimeImmutable( 'now', wp_timezone() );
+ $utc = $local->setTimezone( new DateTimeZone( 'UTC' ) );
+
+ $this->assertEquals(
+ $local->format( 'Y-m-d H:i:s' ),
+ iso8601_to_datetime( $local->format( $format ) ),
+ 'Local time from local time.'
+ );
+ $this->assertEquals(
+ $utc->format( 'Y-m-d H:i:s' ),
+ iso8601_to_datetime( $local->format( $format ), 'gmt' ),
+ 'UTC time from local time.'
+ );
+
+ $this->assertEquals(
+ $local->format( 'Y-m-d H:i:s' ),
+ iso8601_to_datetime( $local->format( $format_no_tz ) ),
+ 'Local time from local time w/o timezone.'
+ );
+ $this->assertEquals(
+ $utc->format( 'Y-m-d H:i:s' ),
+ iso8601_to_datetime( $local->format( $format_no_tz ), 'gmt' ),
+ 'UTC time from local time w/o timezone.'
+ );
+
+ $this->assertEquals(
+ $local->format( 'Y-m-d H:i:s' ),
+ iso8601_to_datetime( $utc->format( $format ) ),
+ 'Local time from UTC time.'
+ );
+ $this->assertEquals(
+ $utc->format( 'Y-m-d H:i:s' ),
+ iso8601_to_datetime( $utc->format( $format ), 'gmt' ),
+ 'UTC time from UTC time.'
+ );
+
+ $this->assertEquals(
+ $local->format( 'Y-m-d H:i:s' ),
+ iso8601_to_datetime( $utc->format( $format_no_tz ) . 'Z' ),
+ 'Local time from UTC w/ Z timezone.'
+ );
+ $this->assertEquals(
+ $utc->format( 'Y-m-d H:i:s' ),
+ iso8601_to_datetime( $utc->format( $format_no_tz ) . 'Z', 'gmt' ),
+ 'UTC time from UTC w/ Z timezone.'
+ );
+ }
+
+ /**
+ * Data provider to test different timezone modes.
+ *
+ * @return array
+ */
+ public function timezone_provider() {
+ return array(
+ array(
+ 'timezone_string' => 'Europe/Kiev',
+ 'gmt_offset' => 3,
+ ),
+ array(
+ 'timezone_string' => '',
+ 'gmt_offset' => 3,
+ ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>