<!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>[29936] trunk: Better "inclusive" support for string values in WP_Date_Query.</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 { 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/29936">29936</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/29936","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-10-17 02:27:44 +0000 (Fri, 17 Oct 2014)</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'>Better "inclusive" support for string values in WP_Date_Query.
The 'inclusive' parameter for WP_Date_Query determines whether non-precise
dates for 'before' and 'after' will be rounded up or down. Previously, this was
supported only when 'before' and 'after' were arrays; string-formatted dates
were run through strtotime(), which rounded them all down (inclusive in the
case of after, non-inclusive in the case of before). Now, we attempt to parse
formats that look like MySQL-formatted date strings, and apply inclusive logic
to them if we recognize them successfully.
Fixes <a href="https://core.trac.wordpress.org/ticket/29908">#29908</a>.
string values. Array values support the 'inclusive</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesdatephp">trunk/src/wp-includes/date.php</a></li>
<li><a href="#trunktestsphpunittestsquerydateQueryphp">trunk/tests/phpunit/tests/query/dateQuery.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesdatephp"></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/date.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/date.php 2014-10-17 01:57:18 UTC (rev 29935)
+++ trunk/src/wp-includes/date.php 2014-10-17 02:27:44 UTC (rev 29936)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -815,16 +815,59 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @access public
</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 string|array $datetime An array of parameters or a strotime() string
- * @param string $default_to Controls what values default to if they are missing from $datetime. Pass "min" or "max".
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|array $datetime An array of parameters or a strotime() string
+ * @param bool $default_to_max Whether to round up incomplete dates. Supported by values
+ * of $datetime that are arrays, or string values that are a
+ * subset of MySQL date format ('Y', 'Y-m', 'Y-m-d', 'Y-m-d H:i').
+ * Default: false.
</ins><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><span class="cx" style="display: block; padding: 0 10px"> $now = current_time( 'timestamp' );
</span><span class="cx" style="display: block; padding: 0 10px">
</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">+
+ /*
+ * Try to parse some common date formats, so we can detect
+ * the level of precision and support the 'inclusive' parameter.
+ */
+ if ( preg_match( '/^(\d{4})$/', $datetime, $matches ) ) {
+ // Y
+ $datetime = array(
+ 'year' => intval( $matches[1] ),
+ );
+
+ } else if ( preg_match( '/^(\d{4})\-(\d{2})$/', $datetime, $matches ) ) {
+ // Y-m
+ $datetime = array(
+ 'year' => intval( $matches[1] ),
+ 'month' => intval( $matches[2] ),
+ );
+
+ } else if ( preg_match( '/^(\d{4})\-(\d{2})\-(\d{2})$/', $datetime, $matches ) ) {
+ // Y-m-d
+ $datetime = array(
+ 'year' => intval( $matches[1] ),
+ 'month' => intval( $matches[2] ),
+ 'day' => intval( $matches[3] ),
+ );
+
+ } else if ( preg_match( '/^(\d{4})\-(\d{2})\-(\d{2}) (\d{2}):(\d{2})$/', $datetime, $matches ) ) {
+ // Y-m-d H:i
+ $datetime = array(
+ 'year' => intval( $matches[1] ),
+ 'month' => intval( $matches[2] ),
+ 'day' => intval( $matches[3] ),
+ 'hour' => intval( $matches[4] ),
+ 'minute' => intval( $matches[5] ),
+ );
+ }
+
+ // If no match is found, we don't support default_to_max.
+ if ( ! is_array( $datetime ) ) {
+ // @todo Timezone issues here possibly
+ return gmdate( 'Y-m-d H:i:s', strtotime( $datetime, $now ) );
+ }
</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"> $datetime = array_map( 'absint', $datetime );
</span></span></pre></div>
<a id="trunktestsphpunittestsquerydateQueryphp"></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/query/dateQuery.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/query/dateQuery.php 2014-10-17 01:57:18 UTC (rev 29935)
+++ trunk/tests/phpunit/tests/query/dateQuery.php 2014-10-17 02:27:44 UTC (rev 29936)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -271,6 +271,378 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</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 29908
+ */
+ public function test_beforeafter_with_date_string_Y() {
+ $p1 = $this->factory->post->create( array(
+ 'post_date' => '2008-05-06 13:00:00',
+ ) );
+ $p2 = $this->factory->post->create( array(
+ 'post_date' => '2007-05-07 13:00:00',
+ ) );
+
+ $before_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'before' => '2008',
+ ),
+ ) );
+
+ $after_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'after' => '2007',
+ ),
+ ) );
+
+ $this->assertEquals( array( $p2 ), $before_posts );
+ $this->assertEquals( array( $p1 ), $after_posts );
+ }
+
+ /**
+ * @ticket 29908
+ */
+ public function test_beforeafter_with_date_string_Y_inclusive() {
+ $p1 = $this->factory->post->create( array(
+ 'post_date' => '2008-05-06 13:00:00',
+ ) );
+ $p2 = $this->factory->post->create( array(
+ 'post_date' => '2007-05-07 13:00:00',
+ ) );
+
+ $before_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'before' => '2008',
+ 'inclusive' => true,
+ ),
+ ) );
+
+ $after_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'after' => '2007',
+ 'inclusive' => true,
+ ),
+ ) );
+
+ $this->assertEqualSets( array( $p1, $p2 ), $before_posts );
+ $this->assertEqualSets( array( $p1, $p2 ), $after_posts );
+ }
+
+ /**
+ * @ticket 29908
+ */
+ public function test_beforeafter_with_date_string_Ym() {
+ $p1 = $this->factory->post->create( array(
+ 'post_date' => '2008-05-06 13:00:00',
+ ) );
+ $p2 = $this->factory->post->create( array(
+ 'post_date' => '2008-04-07 13:00:00',
+ ) );
+
+ $before_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'before' => '2008-05',
+ ),
+ ) );
+
+ $after_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'after' => '2008-04',
+ ),
+ ) );
+
+ $this->assertEquals( array( $p2 ), $before_posts );
+ $this->assertEquals( array( $p1 ), $after_posts );
+ }
+
+ /**
+ * @ticket 29908
+ */
+ public function test_beforeafter_with_date_string_Ym_inclusive() {
+ $p1 = $this->factory->post->create( array(
+ 'post_date' => '2008-05-06 13:00:00',
+ ) );
+ $p2 = $this->factory->post->create( array(
+ 'post_date' => '2008-04-07 13:00:00',
+ ) );
+
+ $before_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'before' => '2008-05',
+ 'inclusive' => true,
+ ),
+ ) );
+
+ $after_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'after' => '2008-04',
+ 'inclusive' => true,
+ ),
+ ) );
+
+ $this->assertEqualSets( array( $p1, $p2 ), $before_posts );
+ $this->assertEqualSets( array( $p1, $p2 ), $after_posts );
+ }
+
+ /**
+ * @ticket 29908
+ */
+ public function test_beforeafter_with_date_string_Ymd() {
+ $p1 = $this->factory->post->create( array(
+ 'post_date' => '2008-05-06 13:00:00',
+ ) );
+ $p2 = $this->factory->post->create( array(
+ 'post_date' => '2008-05-05 13:00:00',
+ ) );
+
+ $before_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'before' => '2008-05-06',
+ ),
+ ) );
+
+ $after_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'after' => '2008-05-05',
+ ),
+ ) );
+
+ $this->assertEquals( array( $p2 ), $before_posts );
+ $this->assertEquals( array( $p1 ), $after_posts );
+ }
+
+ /**
+ * @ticket 29908
+ */
+ public function test_beforeafter_with_date_string_Ymd_inclusive() {
+ $p1 = $this->factory->post->create( array(
+ 'post_date' => '2008-05-06 13:00:00',
+ ) );
+ $p2 = $this->factory->post->create( array(
+ 'post_date' => '2008-05-05 13:00:00',
+ ) );
+
+ $before_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'before' => '2008-05-06',
+ 'inclusive' => true,
+ ),
+ ) );
+
+ $after_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'after' => '2008-05-05',
+ 'inclusive' => true,
+ ),
+ ) );
+
+ $this->assertEqualSets( array( $p1, $p2 ), $before_posts );
+ $this->assertEqualSets( array( $p1, $p2 ), $after_posts );
+ }
+
+ /**
+ * @ticket 29908
+ */
+ public function test_beforeafter_with_date_string_YmdHi() {
+ $p1 = $this->factory->post->create( array(
+ 'post_date' => '2008-05-06 14:05:00',
+ ) );
+ $p2 = $this->factory->post->create( array(
+ 'post_date' => '2008-05-06 14:04:00',
+ ) );
+
+ $before_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'before' => '2008-05-06 14:05',
+ ),
+ ) );
+
+ $after_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'after' => '2008-05-06 14:04',
+ ),
+ ) );
+
+ $this->assertEquals( array( $p2 ), $before_posts );
+ $this->assertEquals( array( $p1 ), $after_posts );
+ }
+
+ /**
+ * @ticket 29908
+ */
+ public function test_beforeafter_with_date_string_YmdHi_inclusive() {
+ $p1 = $this->factory->post->create( array(
+ 'post_date' => '2008-05-06 14:05:00',
+ ) );
+ $p2 = $this->factory->post->create( array(
+ 'post_date' => '2008-05-06 14:04:00',
+ ) );
+
+ $before_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'before' => '2008-05-06 14:05',
+ 'inclusive' => true,
+ ),
+ ) );
+
+ $after_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'after' => '2008-05-06 14:04',
+ 'inclusive' => true,
+ ),
+ ) );
+
+ $this->assertEqualSets( array( $p1, $p2 ), $before_posts );
+ $this->assertEqualSets( array( $p1, $p2 ), $after_posts );
+ }
+
+ /**
+ * @ticket 29908
+ */
+ public function test_beforeafter_with_date_string_YmdHis() {
+ $p1 = $this->factory->post->create( array(
+ 'post_date' => '2008-05-06 14:05:15',
+ ) );
+ $p2 = $this->factory->post->create( array(
+ 'post_date' => '2008-05-06 14:05:14',
+ ) );
+
+ $before_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'before' => '2008-05-06 14:05:15',
+ ),
+ ) );
+
+ $after_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'after' => '2008-05-06 14:05:14',
+ ),
+ ) );
+
+ $this->assertEquals( array( $p2 ), $before_posts );
+ $this->assertEquals( array( $p1 ), $after_posts );
+ }
+
+ /**
+ * @ticket 29908
+ */
+ public function test_beforeafter_with_date_string_YmdHis_inclusive() {
+ $p1 = $this->factory->post->create( array(
+ 'post_date' => '2008-05-06 14:04:15',
+ ) );
+ $p2 = $this->factory->post->create( array(
+ 'post_date' => '2008-05-06 14:04:14',
+ ) );
+
+ $before_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'before' => '2008-05-06 14:04:15',
+ 'inclusive' => true,
+ ),
+ ) );
+
+ $after_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'after' => '2008-05-06 14:04:14',
+ 'inclusive' => true,
+ ),
+ ) );
+
+ $this->assertEqualSets( array( $p1, $p2 ), $before_posts );
+ $this->assertEqualSets( array( $p1, $p2 ), $after_posts );
+ }
+
+ /**
+ * @ticket 29908
+ */
+ public function test_beforeafter_with_date_string_non_parseable() {
+ $p1 = $this->factory->post->create( array(
+ 'post_date' => '2008-05-06 14:05:15',
+ ) );
+ $p2 = $this->factory->post->create( array(
+ 'post_date' => '2008-05-06 14:05:14',
+ ) );
+
+ $before_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'before' => 'June 12, 2008',
+ ),
+ ) );
+
+ $after_posts = $this->_get_query_result( array(
+ 'fields' => 'ids',
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'date_query' => array(
+ 'after' => 'June 12, 2007',
+ ),
+ ) );
+
+ $this->assertEquals( array( $p1, $p2 ), $before_posts );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_date_query_year_expecting_results() {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->create_posts();
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>