<!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>[46580] trunk: Date/Time: Make sure `get_post_time()` keeps UTC time on timezone change.</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/46580">46580</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/46580","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-10-25 13:06:29 +0000 (Fri, 25 Oct 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: Make sure `get_post_time()` keeps UTC time on timezone change.
Add `$source` parameter to `get_post_datetime()` to instantiate from local or UTC time in database.
Props Rarst, david.binda.
Reviewed by azaozz, SergeyBiryukov.
Fixes <a href="https://core.trac.wordpress.org/ticket/48384">#48384</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesgeneraltemplatephp">trunk/src/wp-includes/general-template.php</a></li>
<li><a href="#trunktestsphpunittestsdatepostTimephp">trunk/tests/phpunit/tests/date/postTime.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesgeneraltemplatephp"></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/general-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/general-template.php 2019-10-25 12:52:46 UTC (rev 46579)
+++ trunk/src/wp-includes/general-template.php 2019-10-25 13:06:29 UTC (rev 46580)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2565,7 +2565,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">- $datetime = get_post_datetime( $post );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $source = ( $gmt ) ? 'gmt' : 'local';
+ $datetime = get_post_datetime( $post, 'date', $source );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false === $datetime ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2606,13 +2607,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The object will be set to the timezone from WordPress settings.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * For legacy reasons, this function allows to choose to instantiate from local or UTC time in database.
+ * Normally this should make no difference to the result. However, the values might get out of sync in database,
+ * typically because of timezone setting changes. The parameter ensures the ability to reproduce backwards
+ * compatible behaviors in such cases.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 5.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|WP_Post $post Optional. WP_Post object or ID. Default is global `$post` object.
- * @param string $field Optional. Post field to use. Accepts 'date' or 'modified'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|WP_Post $post Optional. WP_Post object or ID. Default is global `$post` object.
+ * @param string $field Optional. Published or modified time to use from database. Accepts 'date' or 'modified'.
+ * Default 'date'.
+ * @param string $source Optional. Local or UTC time to use from database. Accepts 'local' or 'gmt'.
+ * Default 'local'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return DateTimeImmutable|false Time object on success, false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_post_datetime( $post = null, $field = 'date' ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_post_datetime( $post = null, $field = 'date', $source = 'local' ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $post = get_post( $post );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $post ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2619,13 +2628,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">- $time = ( 'modified' === $field ) ? $post->post_modified : $post->post_date;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_timezone = wp_timezone();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'gmt' === $source ) {
+ $time = ( 'modified' === $field ) ? $post->post_modified_gmt : $post->post_date_gmt;
+ $timezone = new DateTimeZone( 'UTC' );
+ } else {
+ $time = ( 'modified' === $field ) ? $post->post_modified : $post->post_date;
+ $timezone = $wp_timezone;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $time ) || '0000-00-00 00:00:00' === $time ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">- return date_create_immutable_from_format( 'Y-m-d H:i:s', $time, wp_timezone() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $datetime = date_create_immutable_from_format( 'Y-m-d H:i:s', $time, $timezone );
+
+ if ( false === $datetime ) {
+ return false;
+ }
+
+ return $datetime->setTimezone( $wp_timezone );
</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">@@ -2637,7 +2660,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int|WP_Post $post Optional. WP_Post object or ID. Default is global `$post` object.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $field Optional. Post field to use. Accepts 'date' or 'modified'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $field Optional. Published or modified time to use from database. Accepts 'date' or 'modified'.
+ * Default 'date'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return int|false Unix timestamp on success, false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_post_timestamp( $post = null, $field = 'date' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2729,7 +2753,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">- $datetime = get_post_datetime( $post, 'modified' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $source = ( $gmt ) ? 'gmt' : 'local';
+ $datetime = get_post_datetime( $post, 'modified', $source );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false === $datetime ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span></span></pre></div>
<a id="trunktestsphpunittestsdatepostTimephp"></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/date/postTime.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/date/postTime.php 2019-10-25 12:52:46 UTC (rev 46579)
+++ trunk/tests/phpunit/tests/date/postTime.php 2019-10-25 13:06:29 UTC (rev 46580)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -62,4 +62,51 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $rfc3339, get_post_modified_time( DATE_RFC3339, false, $post_id, true ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $rfc3339_utc, get_post_modified_time( DATE_RFC3339, true, $post_id, true ) );
</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 48384
+ */
+ public function test_should_keep_utc_time_on_timezone_change_with_gmt_offset() {
+ // Set the timezone to UTC+0.
+ update_option( 'gmt_offset', 0 );
+
+ $datetime = new DateTimeImmutable( 'now', new DateTimeZone( 'UTC' ) );
+ $mysql = $datetime->format( 'Y-m-d H:i:s' );
+ $rfc3339 = $datetime->format( DATE_RFC3339 );
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_date' => $mysql,
+ 'post_modified' => $mysql,
+ )
+ );
+
+ // Change the timezone to UTC+2.
+ update_option( 'gmt_offset', 2 );
+
+ $this->assertEquals( $rfc3339, get_post_time( DATE_RFC3339, true, $post_id ) );
+ $this->assertEquals( $rfc3339, get_post_modified_time( DATE_RFC3339, true, $post_id ) );
+ }
+
+ /**
+ * @ticket 48384
+ */
+ public function test_should_keep_utc_time_on_timezone_change() {
+ $timezone = 'UTC';
+ update_option( 'timezone_string', $timezone );
+
+ $datetime = new DateTimeImmutable( 'now', new DateTimeZone( $timezone ) );
+ $mysql = $datetime->format( 'Y-m-d H:i:s' );
+ $rfc3339 = $datetime->format( DATE_RFC3339 );
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_date' => $mysql,
+ 'post_modified' => $mysql,
+ )
+ );
+
+ update_option( 'timezone_string', 'Europe/Kiev' );
+
+ $this->assertEquals( $rfc3339, get_post_time( DATE_RFC3339, true, $post_id ) );
+ $this->assertEquals( $rfc3339, get_post_modified_time( DATE_RFC3339, true, $post_id ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>