<!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>[45876] trunk: Date/Time: Use `wp_timezone()` in `WP_Date_Query::build_mysql_datetime()` to address timezone issues.</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/45876">45876</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/45876","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-22 03:10:05 +0000 (Thu, 22 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: Use `wp_timezone()` in `WP_Date_Query::build_mysql_datetime()` to address timezone issues.
Improve unit test coverage.
Props Rarst, Biranit, birgire, jave.web, SergeyBiryukov.
Fixes <a href="https://core.trac.wordpress.org/ticket/41782">#41782</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpdatequeryphp">trunk/src/wp-includes/class-wp-date-query.php</a></li>
<li><a href="#trunktestsphpunittestsdatequeryphp">trunk/tests/phpunit/tests/date/query.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpdatequeryphp"></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/class-wp-date-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-date-query.php 2019-08-22 02:28:50 UTC (rev 45875)
+++ trunk/src/wp-includes/class-wp-date-query.php 2019-08-22 03:10:05 UTC (rev 45876)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -853,7 +853,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * You can pass an array of values (year, month, etc.) with missing parameter values being defaulted to
</span><span class="cx" style="display: block; padding: 0 10px"> * either the maximum or minimum values (controlled by the $default_to parameter). Alternatively you can
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * pass a string that will be run through strtotime().
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * pass a string that will be passed to date_create().
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -865,8 +865,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string|false A MySQL format date/time or false on failure
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function build_mysql_datetime( $datetime, $default_to_max = false ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $now = current_time( 'timestamp' );
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_array( $datetime ) ) {
</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">@@ -907,8 +905,16 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If no match is found, we don't support default_to_max.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_array( $datetime ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // @todo Timezone issues here possibly
- return gmdate( 'Y-m-d H:i:s', strtotime( $datetime, $now ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_timezone = wp_timezone();
+
+ // Assume local timezone if not provided.
+ $dt = date_create( $datetime, $wp_timezone );
+
+ if ( false === $dt ) {
+ return gmdate( 'Y-m-d H:i:s', false );
+ }
+
+ return $dt->setTimezone( $wp_timezone )->format( 'Y-m-d H:i:s' );
</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">@@ -915,7 +921,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $datetime = array_map( 'absint', $datetime );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $datetime['year'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $datetime['year'] = gmdate( 'Y', $now );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $datetime['year'] = current_time( 'Y' );
</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"> if ( ! isset( $datetime['month'] ) ) {
</span></span></pre></div>
<a id="trunktestsphpunittestsdatequeryphp"></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/query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/date/query.php 2019-08-22 02:28:50 UTC (rev 45875)
+++ trunk/tests/phpunit/tests/date/query.php 2019-08-22 03:10:05 UTC (rev 45876)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -509,40 +509,81 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $expected, $found );
</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">- public function test_build_mysql_datetime_default_to_max_true() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @ticket 41782
+ *
+ * @dataProvider mysql_datetime_input_provider
+ *
+ * @param array|string $datetime Array or string date input.
+ * @param string $expected Expected built result.
+ * @param bool $default_to_max Flag to default missing values to max.
+ */
+ public function test_build_mysql_datetime( $datetime, $expected, $default_to_max = false ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $q = new WP_Date_Query( array() );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $found = $q->build_mysql_datetime(
- array(
- 'year' => 2011,
- ),
- true
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $found = $q->build_mysql_datetime( $datetime, $default_to_max );
+
+ $message = "Expected {$expected}, got {$found}";
+ $this->assertEquals( strtotime( $expected ), strtotime( $found ), $message, 10 );
+ }
+
+ public function mysql_datetime_input_provider() {
+ return array(
+ array( '2019-06-04T08:18:24+03:00', '2019-06-04 05:18:24' ),
+ array( '2019-06-04T05:18:24+00:00', '2019-06-04 05:18:24' ),
+ array( array(), current_time( 'Y' ) . '-01-01 00:00:00' ),
+ array( array( 'year' => 2011 ), '2011-12-31 23:59:59', true ),
+ array( array( 'year' => 2011 ), '2011-01-01 00:00:00' ),
+ array( '2011', '2011-01-01 00:00:00' ),
+ array( '2011-02', '2011-02-01 00:00:00' ),
+ array( '2011-02-03', '2011-02-03 00:00:00' ),
+ array( '2011-02-03 13:30', '2011-02-03 13:30:00' ),
+ array( '2011-02-03 13:30:35', '2011-02-03 13:30:35' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( '2011-12-31 23:59:59', $found );
</del><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">- public function test_build_mysql_datetime_default_to_max_false() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @ticket 41782
+ *
+ * @dataProvider mysql_datetime_input_provider_custom_timezone
+ *
+ * @param array|string $datetime Array or string date input.
+ * @param string $expected Expected built result.
+ * @param bool $default_to_max Flag to default missing values to max.
+ */
+ public function test_build_mysql_datetime_with_custom_timezone( $datetime, $expected, $default_to_max = false ) {
+ update_option( 'timezone_string', 'Europe/Kiev' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $q = new WP_Date_Query( array() );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $found = $q->build_mysql_datetime(
- array(
- 'year' => 2011,
- ),
- false
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $found = $q->build_mysql_datetime( $datetime, $default_to_max );
+
+ $message = "Expected {$expected}, got {$found}";
+ $this->assertEquals( strtotime( $expected ), strtotime( $found ), $message, 10 );
+
+ }
+
+ public function mysql_datetime_input_provider_custom_timezone() {
+ return array(
+ array( '2019-06-04T08:18:24+03:00', '2019-06-04 08:18:24' ),
+ array( '2019-06-04T05:18:24+00:00', '2019-06-04 08:18:24' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( '2011-01-01 00:00:00', $found );
</del><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">- public function test_build_mysql_datetime_default_to_max_default_to_false() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @ticket 41782
+ */
+ public function test_build_mysql_datetime_with_relative_date() {
+ update_option( 'timezone_string', 'Europe/Kiev' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $q = new WP_Date_Query( array() );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $found = $q->build_mysql_datetime(
- array(
- 'year' => 2011,
- ),
- false
- );
- $this->assertSame( '2011-01-01 00:00:00', $found );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $yesterday = new DateTimeImmutable( '-1 day', wp_timezone() );
+ $expected = $yesterday->format( 'Y-m-d H:i:s' );
+ $found = $q->build_mysql_datetime( '-1 day' );
+
+ $message = "Expected {$expected}, got {$found}";
+ $this->assertEquals( strtotime( $expected ), strtotime( $found ), $message, 10 );
</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"> public function test_build_time_query_insufficient_time_values() {
</span></span></pre>
</div>
</div>
</body>
</html>