sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

WP_Date_Query.

Browse Source 
props Viper007Bond.
see #18694.


git-svn-id: https://develop.svn.wordpress.org/trunk@25139 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Andrew Nacin 2013-08-27 16:38:32 +00:00
parent 86f5f6ac78
commit c637de7316
7 changed files with 1466 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/wp-includes/comment.php
View File

@ -196,6 +196,15 @@ class WP_Comment_Query {
*/
var $meta_query = false;
/**
* Date query container
*
* @since 3.7.0
* @access public
* @var object WP_Date_Query
*/
var $date_query = false;
/**
* Execute the query
*
@ -231,6 +240,7 @@ class WP_Comment_Query {
'meta_key' => '',
'meta_value' => '',
'meta_query' => '',
'date_query' => null, // See WP_Date_Query
);
$groupby = '';
@ -360,6 +370,11 @@ class WP_Comment_Query {
$groupby = "{$wpdb->comments}.comment_ID";
}
if ( ! empty( $date_query ) && is_array( $date_query ) ) {
$date_query_object = new WP_Date_Query( $date_query, 'comment_date' );
$where .= $date_query_object->get_sql();
}
$pieces = array( 'fields', 'join', 'where', 'orderby', 'order', 'limits', 'groupby' );
$clauses = apply_filters_ref_array( 'comments_clauses', array( compact( $pieces ), &$this ) );
foreach ( $pieces as $piece )

403
src/wp-includes/date.php Normal file
View File

@ -0,0 +1,403 @@
<?php
/**
* WP_Date_Query will generate a MySQL WHERE clause for the specified date-based parameters.
*
* Initialize the class by passing an array of arrays of parameters. Example:
*
* $date_query = new WP_Date_Query( array(
* 'column' => 'optional, column to query against, default is post_date',
* 'compare' => 'optional, see WP_Date_Query::get_compare()',
* 'relation' => 'optional, OR or AND, how the sub-arrays should be compared, default is AND',
* array(
* 'column' => 'see above',
* 'compare' => 'see above',
* 'after' => 'string or array, see WP_Date_Query::build_mysql_datetime()',
* 'before' => 'string or array, see WP_Date_Query::build_mysql_datetime()',
* 'inclusive' => 'boolean, for after/before, whether exact value should be matched or not',
* 'year' => '4 digit int',
* 'month' => 'int, 1-12',
* 'week' => 'int, 0-53',
* 'day' => 'int, 1-31',
* 'hour' => 'int, 0-23',
* 'minute' => 'int, 0-60',
* 'second' => 'int, 0-60',
* ),
* array(
* ...
* ),
* ...
* ) );
*
* Then call the get_sql() method to get the MySQL WHERE string:
*
* $where .= $date_query->get_sql();
*
* @link http://codex.wordpress.org/Function_Reference/WP_Query Codex page.
*
* @since 3.7.0
*/
class WP_Date_Query {
/**
* List of date queries.
*
* @since 3.7.0
* @access public
* @var array
*/
public $queries = array();
/**
* The relation between the queries. Can be either 'AND' or 'OR' and can be changed via the query arguments.
*
* @since 3.7.0
* @access public
* @var string
*/
public $relation = 'AND';
/**
* The column to query against. Can be changed via the query arguments.
*
* @since 3.7.0
* @access public
* @var string
*/
public $column = 'post_date';
/**
* The value comparison operator. Can be changed via the query arguments.
*
* @since 3.7.0
* @access public
* @var array
*/
public $compare = '=';
/**
* Constructor
*
* @param array $date_query A date query parameter array, see class descriptor for further details.
* @param array (optional) $default_column What column name to query against. Defaults to "post_date".
*/
function __construct( $date_query, $default_column = 'post_date' ) {
if ( empty( $date_query ) || ! is_array( $date_query ) )
return;
if ( isset( $date_query['relation'] ) && strtoupper( $date_query['relation'] ) == 'OR' )
$this->relation = 'OR';
else
$this->relation = 'AND';
if ( ! empty( $date_query['column'] ) )
$this->column = esc_sql( $date_query['column'] );
else
$this->column = esc_sql( $default_column );
$this->column = $this->validate_column( $this->column );
$this->compare = $this->get_compare( $date_query );
// If an array of arrays wasn't passed, fix it
if ( ! isset( $date_query[0] ) )
$date_query = array( $date_query );
$this->queries = array();
foreach ( $date_query as $key => $query ) {
if ( ! is_array( $query ) )
continue;
$this->queries[$key] = $query;
}
}
/**
* Determines and validates what comparison operator to use.
*
* @since 3.7.0
* @access public
*
* @param array $query A date query or a date subquery
* @return string The comparison operator
*/
public function get_compare( $query ) {
if ( ! empty( $query['compare'] ) && in_array( $query['compare'], array( '=', '!=', '>', '>=', '<', '<=', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) )
return strtoupper( $query['compare'] );
return $this->compare;
}
/**
* Validates a column name parameter.
*
* @since 3.7.0
* @access public
*
* @param string $column The user-supplied column name.
* @return string A validated column name value.
*/
public function validate_column( $column ) {
if ( ! in_array( $column, apply_filters( 'date_query_valid_columns', array( 'post_date', 'post_date_gmt', 'post_modified', 'post_modified_gmt', 'comment_date', 'comment_date_gmt' ) ) ) )
$column = 'post_date';
return $column;
}
/**
* Turns an array of date query parameters into a MySQL string.
*
* @since 3.7.0
* @access public
*
* @return string MySQL WHERE parameters
*/
public function get_sql() {
// The parts of the final query
$where = array();
foreach ( $this->queries as $key => $query ) {
$where_parts = $this->get_sql_for_subquery( $query );
if ( $where_parts ) {
// Combine the parts of this subquery into a single string
$where[ $key ] = '( ' . implode( ' AND ', $where_parts ) . ' )';
}
}
// Combine the subquery strings into a single string
if ( $where )
$where = ' AND ( ' . implode( " {$this->relation} ", $where ) . ' )';
else
$where = '';
return apply_filters( 'get_date_sql', $where, $this );
}
/**
* Turns a single date subquery into pieces for a WHERE clause.
*
* @since 3.7.0
* return array
*/
protected function get_sql_for_subquery( $query ) {
global $wpdb;
// The sub-parts of a $where part
$where_parts = array();
$column = ( ! empty( $query['column'] ) ) ? esc_sql( $query['column'] ) : $this->column;
$column = $this->validate_column( $column );
$compare = $this->get_compare( $query );
$lt = '<';
$gt = '>';
if ( ! empty( $query['inclusive'] ) ) {
$lt .= '=';
$gt .= '=';
}
// Range queries
if ( ! empty( $query['after'] ) )
$where_parts[] = $wpdb->prepare( "$column $gt %s", $this->build_mysql_datetime( $query['after'], true ) );
if ( ! empty( $query['before'] ) )
$where_parts[] = $wpdb->prepare( "$column $lt %s", $this->build_mysql_datetime( $query['before'], false ) );
// Specific value queries
if ( isset( $query['year'] ) && $value = $this->build_value( $compare, $query['year'] ) )
$where_parts[] = "YEAR( $column ) $compare $value";
if ( isset( $query['month'] ) && $value = $this->build_value( $compare, $query['month'] ) )
$where_parts[] = "MONTH( $column ) $compare $value";
// Legacy
if ( isset( $query['monthnum'] ) && $value = $this->build_value( $compare, $query['monthnum'] ) )
$where_parts[] = "MONTH( $column ) $compare $value";
if ( isset( $query['week'] ) && false !== ( $value = $this->build_value( $compare, $query['week'] ) ) )
$where_parts[] = _wp_mysql_week( $column ) . " $compare $value";
// Legacy
if ( isset( $query['w'] ) && false !== ( $value = $this->build_value( $compare, $query['w'] ) ) )
$where_parts[] = _wp_mysql_week( $column ) . " $compare $value";
if ( isset( $query['dayofyear'] ) && $value = $this->build_value( $compare, $query['dayofyear'] ) )
$where_parts[] = "DAYOFYEAR( $column ) $compare $value";
if ( isset( $query['day'] ) && $value = $this->build_value( $compare, $query['day'] ) )
$where_parts[] = "DAYOFMONTH( $column ) $compare $value";
if ( isset( $query['dayofweek'] ) && $value = $this->build_value( $compare, $query['dayofweek'] ) )
$where_parts[] = "DAYOFWEEK( $column ) $compare $value";
if ( isset( $query['hour'] ) || isset( $query['minute'] ) || isset( $query['second'] ) ) {
// Avoid notices
foreach ( array( 'hour', 'minute', 'second' ) as $unit ) {
if ( ! isset( $query[$unit] ) ) {
$query[$unit] = null;
}
}
if ( $time_query = $this->build_time_query( $column, $compare, $query['hour'], $query['minute'], $query['second'] ) ) {
$where_parts[] = $time_query;
}
}
return $where_parts;
}
/**
* Builds and validates a value string based on the comparison operator.
*
* @since 3.7.0
* @access public
*
* @param string $compare The compare operator to use
* @param string|array $value The value
* @return string|int|false The value to be used in SQL or false on error.
*/
public function build_value( $compare, $value ) {
if ( ! isset( $value ) )
return false;
switch ( $compare ) {
case 'IN':
case 'NOT IN':
return '(' . implode( ',', array_map( 'intval', (array) $value ) ) . ')';
case 'BETWEEN':
case 'NOT BETWEEN':
if ( ! is_array( $value ) || 2 != count( $value ) || ! isset( $value[0] ) || ! isset( $value[1] ) )
$value = array( $value, $value );
$value = array_map( 'intval', $value );
return $value[0] . ' AND ' . $value[1];
default;
return (int) $value;
}
}
/**
* Builds a MySQL format date/time based on some query parameters.
*
* You can pass an array of values (year, month, etc.) with missing parameter values being defaulted to
* either the maximum or minimum values (controlled by the $default_to parameter). Alternatively you can
* pass a string that that will be run through strtotime().
*
* @since 3.7.0
* @access public
*
* @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".
* @return string|false A MySQL format date/time or false on failure
*/
public function build_mysql_datetime( $datetime, $default_to_max = false ) {
$now = current_time( 'timestamp' );
if ( ! is_array( $datetime ) ) {
// @todo Timezone issues here possibly
return gmdate( 'Y-m-d H:i:s', strtotime( $datetime, $now ) );
}
$datetime = array_map( 'absint', $datetime );
if ( ! isset( $datetime['year'] ) )
$datetime['year'] = gmdate( 'Y', $now );
if ( ! isset( $datetime['month'] ) )
$datetime['month'] = ( $default_to_max ) ? 12 : 1;
if ( ! isset( $datetime['day'] ) )
$datetime['day'] = ( $default_to_max ) ? (int) date( 't', mktime( 0, 0, 0, $datetime['month'], 1, $datetime['year'] ) ) : 1;
if ( ! isset( $datetime['hour'] ) )
$datetime['hour'] = ( $default_to_max ) ? 23 : 0;
if ( ! isset( $datetime['minute'] ) )
$datetime['minute'] = ( $default_to_max ) ? 59 : 0;
if ( ! isset( $datetime['second'] ) )
$datetime['second'] = ( $default_to_max ) ? 59 : 0;
return sprintf( '%04d-%02d-%02d %02d:%02d:%02d', $datetime['year'], $datetime['month'], $datetime['day'], $datetime['hour'], $datetime['minute'], $datetime['second'] );
}
/**
* Builds a query string for comparing time values (hour, minute, second).
*
* If just hour, minute, or second is set than a normal comparison will be done.
* However if multiple values are passed, a pseudo-decimal time will be created
* in order to be able to accurately compare against.
*
* @since 3.7.0
* @access public
*
* @param string $column The column to query against. Needs to be pre-validated!
* @param string $compare The comparison operator. Needs to be pre-validated!
* @param int|null $hour Optional. An hour value (0-23).
* @param int|null $minute Optional. A minute value (0-59).
* @param int|null $second Optional. A second value (0-59).
* @return string|false A query part or false on failure.
*/
public function build_time_query( $column, $compare, $hour = null, $minute = null, $second = null ) {
global $wpdb;
// Have to have at least one
if ( ! isset( $hour ) && ! isset( $minute ) && ! isset( $second ) )
return false;
// Complex combined queries aren't supported for multi-value queries
if ( in_array( $compare, array( 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) ) {
$return = array();
if ( isset( $hour ) && false !== ( $value = $this->build_value( $compare, $hour ) ) )
$return[] = "HOUR( $column ) $compare $value";
if ( isset( $minute ) && false !== ( $value = $this->build_value( $compare, $minute ) ) )
$return[] = "MINUTE( $column ) $compare $value";
if ( isset( $second ) && false !== ( $value = $this->build_value( $compare, $second ) ) )
$return[] = "SECOND( $column ) $compare $value";
return implode( ' AND ', $return );
}
// Cases where just one unit is set
if ( isset( $hour ) && ! isset( $minute ) && ! isset( $second ) && false !== ( $value = $this->build_value( $compare, $hour ) ) ) {
return "HOUR( $column ) $compare $value";
} elseif ( ! isset( $hour ) && isset( $minute ) && ! isset( $second ) && false !== ( $value = $this->build_value( $compare, $minute ) ) ) {
return "MINUTE( $column ) $compare $value";
} elseif ( ! isset( $hour ) && ! isset( $minute ) && isset( $second ) && false !== ( $value = $this->build_value( $compare, $second ) ) ) {
return "SECOND( $column ) $compare $value";
}
// Single units were already handled. Since hour & second isn't allowed, minute must to be set.
if ( ! isset( $minute ) )
return false;
$format = $time = '';
// Hour
if ( $hour ) {
$format .= '%H.';
$time .= sprintf( '%02d', $hour ) . '.';
} else {
$format .= '0.';
$time .= '0.';
}
// Minute
$format .= '%i';
$time .= sprintf( '%02d', $minute );
if ( isset( $second ) ) {
$format .= '%s';
$time .= sprintf( '%02d', $second );
}
return $wpdb->prepare( "DATE_FORMAT( $column, %s ) $compare %f", $format, $time );
}
}

44
src/wp-includes/query.php
View File

@ -866,6 +866,15 @@ class WP_Query {
*/
var $meta_query = false;
/**
* Date query container
*
* @since 3.7.0
* @access public
* @var object WP_Date_Query
*/
var $date_query = false;
/**
* Holds the data for a single object that is queried.
*
@ -2045,7 +2054,7 @@ class WP_Query {
if ( '' !== $q['menu_order'] )
$where .= " AND $wpdb->posts.menu_order = " . $q['menu_order'];
// If a month is specified in the querystring, load that month
// The "m" parameter is meant for months but accepts datetimes of varying specificity
if ( $q['m'] ) {
$where .= " AND YEAR($wpdb->posts.post_date)=" . substr($q['m'], 0, 4);
if ( strlen($q['m']) > 5 )
@ -2060,23 +2069,42 @@ class WP_Query {
$where .= " AND SECOND($wpdb->posts.post_date)=" . substr($q['m'], 12, 2);
}
// Handle the other individual date parameters
$date_parameters = array();
if ( '' !== $q['hour'] )
$where .= " AND HOUR($wpdb->posts.post_date)='" . $q['hour'] . "'";
$date_parameters['hour'] = $q['hour'];
if ( '' !== $q['minute'] )
$where .= " AND MINUTE($wpdb->posts.post_date)='" . $q['minute'] . "'";
$date_parameters['minute'] = $q['minute'];
if ( '' !== $q['second'] )
$where .= " AND SECOND($wpdb->posts.post_date)='" . $q['second'] . "'";
$date_parameters['second'] = $q['second'];
if ( $q['year'] )
$where .= " AND YEAR($wpdb->posts.post_date)='" . $q['year'] . "'";
$date_parameters['year'] = $q['year'];
if ( $q['monthnum'] )
$where .= " AND MONTH($wpdb->posts.post_date)='" . $q['monthnum'] . "'";
$date_parameters['monthnum'] = $q['monthnum'];
if ( $q['w'] )
$date_parameters['week'] = $q['w'];
if ( $q['day'] )
$where .= " AND DAYOFMONTH($wpdb->posts.post_date)='" . $q['day'] . "'";
$date_parameters['day'] = $q['day'];
if ( $date_parameters ) {
$date_query = new WP_Date_Query( array( $date_parameters ) );
$where .= $date_query->get_sql();
}
unset( $date_parameters, $date_query );
// Handle complex date queries
if ( ! empty( $q['date_query'] ) ) {
$this->date_query = new WP_Date_Query( $q['date_query'] );
$where .= $this->date_query->get_sql();
}
// If we've got a post_type AND it's not "any" post_type.
if ( !empty($q['post_type']) && 'any' != $q['post_type'] ) {
@ -2146,8 +2174,6 @@ class WP_Query {
$where .= " AND $wpdb->posts.post_name = '" . $q['attachment'] . "'";
}
if ( $q['w'] )
$where .= ' AND ' . _wp_mysql_week( "`$wpdb->posts`.`post_date`" ) . " = '" . $q['w'] . "'";
if ( intval($q['comments_popup']) )
$q['p'] = absint($q['comments_popup']);

1
src/wp-settings.php
View File

@ -107,6 +107,7 @@ require( ABSPATH . WPINC . '/class-wp-ajax-response.php' );
require( ABSPATH . WPINC . '/formatting.php' );
require( ABSPATH . WPINC . '/capabilities.php' );
require( ABSPATH . WPINC . '/query.php' );
require( ABSPATH . WPINC . '/date.php' );
require( ABSPATH . WPINC . '/theme.php' );
require( ABSPATH . WPINC . '/class-wp-theme.php' );
require( ABSPATH . WPINC . '/template.php' );

75
tests/tests/comment/dateQuery.php Normal file
View File

@ -0,0 +1,75 @@
<?php
/**
* Tests to make sure querying posts based on various date parameters
* using "date_query" works as expected.
*
* No need to do a full repeat of all of the post tests again since
* the query SQL is the same for both just with a different column.
*
* @ticket 18694
*
* @group comment
* @group date
* @group datequery
*/
class Tests_Comment_DateQuery extends WP_UnitTestCase {
public $posts = array();
public function setUp() {
parent::setUp();
// Just some dummy posts to use as parents for comments
for ( $i = 1; $i <= 2; $i++ ) {
$this->posts[$i] = $this->factory->post->create();
}
// Be careful modifying this. Tests are coded to expect this exact sample data.
// Format is 'datetime' => 'post number (not ID)'
$comment_dates = array(
'2007-01-22 03:49:21' => 1,
'2007-05-16 17:32:22' => 1,
'2007-09-24 07:17:23' => 1,
'2008-03-29 09:04:25' => 1,
'2008-07-15 11:32:26' => 2, // This one should never be in the results
'2008-12-10 13:06:27' => 1,
'2009-06-11 21:30:28' => 1,
'2009-12-18 10:42:29' => 1,
);
foreach ( $comment_dates as $comment_date => $comment_parent ) {
$result = $this->factory->comment->create( array(
'comment_date' => $comment_date,
'comment_post_ID' => $this->posts[ $comment_parent ],
) );
}
}
public function _get_query_result( $args = array() ) {
$args = wp_parse_args( $args, array(
'post_id' => $this->posts[1],
'orderby' => 'comment_ID', // Same order they were created
'order' => 'ASC',
) );
return get_comments( $args );
}
public function test_year() {
$comments = $this->_get_query_result( array(
'date_query' => array(
array(
'year' => 2008,
),
),
) );
$expected_dates = array(
'2008-03-29 09:04:25',
'2008-12-10 13:06:27',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $comments, 'comment_date' ) );
}
}

379
tests/tests/query/date.php Normal file
View File

@ -0,0 +1,379 @@
<?php
/**
* Tests to make sure querying posts based on various date parameters works as expected.
*
* @group query
* @group date
*/
class Tests_Query_Date extends WP_UnitTestCase {
public $q;
public function setUp() {
parent::setUp();
// Be careful modifying this. Tests are coded to expect this exact sample data.
$post_dates = array(
'1972-05-24 14:53:45',
'1984-07-28 19:28:56',
'2003-05-27 22:45:07',
'2004-01-03 08:54:10',
'2004-05-22 12:34:12',
'2005-02-17 00:00:15',
'2005-12-31 23:59:20',
'2007-01-22 03:49:21',
'2007-05-16 17:32:22',
'2007-09-24 07:17:23',
'2008-03-29 09:04:25',
'2008-07-15 11:32:26',
'2008-12-10 13:06:27',
'2009-06-11 21:30:28',
'2009-12-18 10:42:29',
'2010-06-17 17:09:30',
'2011-02-23 12:12:31',
'2011-07-04 01:56:32',
'2011-12-12 16:39:33',
'2012-06-13 14:03:34',
'2025-04-20 10:13:00',
'2025-04-20 10:13:01',
'2025-05-20 10:13:01',
);
foreach ( $post_dates as $post_date ) {
$this->factory->post->create( array( 'post_date' => $post_date ) );
}
unset( $this->q );
$this->q = new WP_Query();
}
public function _get_query_result( $args = array() ) {
$args = wp_parse_args( $args, array(
'post_status' => 'any', // For the future post
'posts_per_page' => '-1', // To make sure results are accurate
'orderby' => 'ID', // Same order they were created
'order' => 'ASC',
) );
return $this->q->query( $args );
}
public function test_simple_year_expecting_results() {
$posts = $this->_get_query_result( array(
'year' => 2008,
) );
$expected_dates = array(
'2008-03-29 09:04:25',
'2008-07-15 11:32:26',
'2008-12-10 13:06:27',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_simple_year_expecting_noresults() {
$posts = $this->_get_query_result( array(
'year' => 2000,
) );
$this->assertCount( 0, $posts );
}
public function test_simple_m_with_year_expecting_results() {
$posts = $this->_get_query_result( array(
'm' => '2007',
) );
$expected_dates = array(
'2007-01-22 03:49:21',
'2007-05-16 17:32:22',
'2007-09-24 07:17:23',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_simple_m_with_year_expecting_noresults() {
$posts = $this->_get_query_result( array(
'm' => '1999',
) );
$this->assertCount( 0, $posts );
}
public function test_simple_m_with_yearmonth_expecting_results() {
$posts = $this->_get_query_result( array(
'm' => '202504',
) );
$expected_dates = array(
'2025-04-20 10:13:00',
'2025-04-20 10:13:01',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_simple_m_with_yearmonth_expecting_noresults() {
$posts = $this->_get_query_result( array(
'm' => '202502',
) );
$this->assertCount( 0, $posts );
}
public function test_simple_m_with_yearmonthday_expecting_results() {
$posts = $this->_get_query_result( array(
'm' => '20250420',
) );
$expected_dates = array(
'2025-04-20 10:13:00',
'2025-04-20 10:13:01',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_simple_m_with_yearmonthday_expecting_noresults() {
$posts = $this->_get_query_result( array(
'm' => '20250419',
) );
$this->assertCount( 0, $posts );
}
public function test_simple_m_with_yearmonthdayhour_expecting_results() {
$posts = $this->_get_query_result( array(
'm' => '2025042010',
) );
$expected_dates = array(
'2025-04-20 10:13:00',
'2025-04-20 10:13:01',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_simple_m_with_yearmonthdayhour_expecting_noresults() {
$posts = $this->_get_query_result( array(
'm' => '2025042009',
) );
$this->assertCount( 0, $posts );
}
/**
* @ticket 24884
*/
public function test_simple_m_with_yearmonthdayhourminute_expecting_results() {
$posts = $this->_get_query_result( array(
'm' => '202504201013',
) );
$expected_dates = array(
'2025-04-20 10:13:00',
'2025-04-20 10:13:01',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
/**
* @ticket 24884
*/
public function test_simple_m_with_yearmonthdayhourminute_expecting_noresults() {
$posts = $this->_get_query_result( array(
'm' => '202504201012',
) );
$this->assertCount( 0, $posts );
}
/**
* @ticket 24884
*/
public function test_simple_m_with_yearmonthdayhourminutesecond_expecting_results() {
$posts = $this->_get_query_result( array(
'm' => '20250420101301',
) );
$expected_dates = array(
'2025-04-20 10:13:01',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
/**
* @ticket 24884
*/
public function test_simple_m_with_yearmonthdayhourminutesecond_expecting_noresults() {
$posts = $this->_get_query_result( array(
'm' => '20250420101302',
) );
$this->assertCount( 0, $posts );
}
/**
* @ticket 24884
*/
public function test_simple_m_with_yearmonthdayhourminutesecond_and_dashes_expecting_results() {
$posts = $this->_get_query_result( array(
'm' => '2025-04-20 10:13:00',
) );
$expected_dates = array(
'2025-04-20 10:13:00',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
/**
* @ticket 24884
*/
public function test_simple_m_with_yearmonthdayhourminutesecond_and_dashesletters_expecting_results() {
$posts = $this->_get_query_result( array(
'm' => 'alpha2025-04-20 10:13:00',
) );
$expected_dates = array(
'2025-04-20 10:13:00',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_simple_monthnum_expecting_results() {
$posts = $this->_get_query_result( array(
'monthnum' => 5,
) );
$expected_dates = array(
'1972-05-24 14:53:45',
'2003-05-27 22:45:07',
'2004-05-22 12:34:12',
'2007-05-16 17:32:22',
'2025-05-20 10:13:01',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_simple_monthnum_expecting_noresults() {
$posts = $this->_get_query_result( array(
'monthnum' => 8,
) );
$this->assertCount( 0, $posts );
}
public function test_simple_w_as_in_week_expecting_results() {
$posts = $this->_get_query_result( array(
'w' => 24,
) );
$expected_dates = array(
'2009-06-11 21:30:28',
'2010-06-17 17:09:30',
'2012-06-13 14:03:34',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_simple_w_as_in_week_expecting_noresults() {
$posts = $this->_get_query_result( array(
'w' => 2,
) );
$this->assertCount( 0, $posts );
}
public function test_simple_day_expecting_results() {
$posts = $this->_get_query_result( array(
'day' => 22,
) );
$expected_dates = array(
'2004-05-22 12:34:12',
'2007-01-22 03:49:21',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_simple_day_expecting_noresults() {
$posts = $this->_get_query_result( array(
'day' => 30,
) );
$this->assertCount( 0, $posts );
}
public function test_simple_hour_expecting_results() {
$posts = $this->_get_query_result( array(
'hour' => 21,
) );
$expected_dates = array(
'2009-06-11 21:30:28',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_simple_hour_expecting_noresults() {
$posts = $this->_get_query_result( array(
'hour' => 2,
) );
$this->assertCount( 0, $posts );
}
public function test_simple_minute_expecting_results() {
$posts = $this->_get_query_result( array(
'minute' => 32,
) );
$expected_dates = array(
'2007-05-16 17:32:22',
'2008-07-15 11:32:26',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_simple_minute_expecting_noresults() {
$posts = $this->_get_query_result( array(
'minute' => 1,
) );
$this->assertCount( 0, $posts );
}
public function test_simple_second_expecting_results() {
$posts = $this->_get_query_result( array(
'second' => 30,
) );
$expected_dates = array(
'2010-06-17 17:09:30',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_simple_second_expecting_noresults() {
$posts = $this->_get_query_result( array(
'second' => 50,
) );
$this->assertCount( 0, $posts );
}
}

558
tests/tests/query/dateQuery.php Normal file
View File

@ -0,0 +1,558 @@
<?php
/**
* Tests to make sure querying posts based on various date parameters using "date_query" works as expected.
*
* @ticket 18694
*
* @group query
* @group date
* @group datequery
*/
class Tests_Query_DateQuery extends WP_UnitTestCase {
public $q;
public function setUp() {
parent::setUp();
// Be careful modifying this. Tests are coded to expect this exact sample data.
$post_dates = array(
'1972-05-24 14:53:45',
'1984-07-28 19:28:56',
'2003-05-27 22:45:07',
'2004-01-03 08:54:10',
'2004-05-22 12:34:12',
'2005-02-17 00:00:15',
'2005-12-31 23:59:20',
'2007-01-22 03:49:21',
'2007-05-16 17:32:22',
'2007-09-24 07:17:23',
'2008-03-29 09:04:25',
'2008-07-15 11:32:26',
'2008-12-10 13:06:27',
'2009-06-11 21:30:28',
'2009-12-18 10:42:29',
'2010-06-17 17:09:30',
'2011-02-23 12:12:31',
'2011-07-04 01:56:32',
'2011-12-12 16:39:33',
'2012-06-13 14:03:34',
'2025-04-20 10:13:00',
'2025-04-20 10:13:01',
'2025-05-20 10:13:01',
);
foreach ( $post_dates as $post_date ) {
$this->factory->post->create( array( 'post_date' => $post_date ) );
}
unset( $this->q );
$this->q = new WP_Query();
}
public function _get_query_result( $args = array() ) {
$args = wp_parse_args( $args, array(
'post_status' => 'any', // For the future post
'posts_per_page' => '-1', // To make sure results are accurate
'orderby' => 'ID', // Same order they were created
'order' => 'ASC',
) );
return $this->q->query( $args );
}
public function test_date_query_before_array() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'before' => array(
'year' => 2008,
'month' => 6,
),
),
),
) );
$expected_dates = array(
'1972-05-24 14:53:45',
'1984-07-28 19:28:56',
'2003-05-27 22:45:07',
'2004-01-03 08:54:10',
'2004-05-22 12:34:12',
'2005-02-17 00:00:15',
'2005-12-31 23:59:20',
'2007-01-22 03:49:21',
'2007-05-16 17:32:22',
'2007-09-24 07:17:23',
'2008-03-29 09:04:25',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
/**
* Specifically tests to make sure values are defaulting to
* their minimum values when being used with "before".
*/
public function test_date_query_before_array_test_defaulting() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'before' => array(
'year' => 2008,
),
),
),
) );
$expected_dates = array(
'1972-05-24 14:53:45',
'1984-07-28 19:28:56',
'2003-05-27 22:45:07',
'2004-01-03 08:54:10',
'2004-05-22 12:34:12',
'2005-02-17 00:00:15',
'2005-12-31 23:59:20',
'2007-01-22 03:49:21',
'2007-05-16 17:32:22',
'2007-09-24 07:17:23',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_date_query_before_string() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'before' => 'May 4th, 2008',
),
),
) );
$expected_dates = array(
'1972-05-24 14:53:45',
'1984-07-28 19:28:56',
'2003-05-27 22:45:07',
'2004-01-03 08:54:10',
'2004-05-22 12:34:12',
'2005-02-17 00:00:15',
'2005-12-31 23:59:20',
'2007-01-22 03:49:21',
'2007-05-16 17:32:22',
'2007-09-24 07:17:23',
'2008-03-29 09:04:25',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_date_query_after_array() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'after' => array(
'year' => 2009,
'month' => 12,
'day' => 31,
),
),
),
) );
$expected_dates = array(
'2010-06-17 17:09:30',
'2011-02-23 12:12:31',
'2011-07-04 01:56:32',
'2011-12-12 16:39:33',
'2012-06-13 14:03:34',
'2025-04-20 10:13:00',
'2025-04-20 10:13:01',
'2025-05-20 10:13:01',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
/**
* Specifically tests to make sure values are defaulting to
* their maximum values when being used with "after".
*/
public function test_date_query_after_array_test_defaulting() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'after' => array(
'year' => 2008,
),
),
),
) );
$expected_dates = array(
'2009-06-11 21:30:28',
'2009-12-18 10:42:29',
'2010-06-17 17:09:30',
'2011-02-23 12:12:31',
'2011-07-04 01:56:32',
'2011-12-12 16:39:33',
'2012-06-13 14:03:34',
'2025-04-20 10:13:00',
'2025-04-20 10:13:01',
'2025-05-20 10:13:01',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_date_query_after_string() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'after' => '2009-12-18 10:42:29',
),
),
) );
$expected_dates = array(
'2010-06-17 17:09:30',
'2011-02-23 12:12:31',
'2011-07-04 01:56:32',
'2011-12-12 16:39:33',
'2012-06-13 14:03:34',
'2025-04-20 10:13:00',
'2025-04-20 10:13:01',
'2025-05-20 10:13:01',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_date_query_after_string_inclusive() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'after' => '2009-12-18 10:42:29',
'inclusive' => true,
),
),
) );
$expected_dates = array(
'2009-12-18 10:42:29',
'2010-06-17 17:09:30',
'2011-02-23 12:12:31',
'2011-07-04 01:56:32',
'2011-12-12 16:39:33',
'2012-06-13 14:03:34',
'2025-04-20 10:13:00',
'2025-04-20 10:13:01',
'2025-05-20 10:13:01',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_date_query_year_expecting_results() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'year' => 2009,
),
),
) );
$expected_dates = array(
'2009-06-11 21:30:28',
'2009-12-18 10:42:29',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_date_query_year_expecting_noresults() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'year' => 2001,
),
),
) );
$this->assertCount( 0, $posts );
}
public function test_date_query_month_expecting_results() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'month' => 12,
),
),
) );
$expected_dates = array(
'2005-12-31 23:59:20',
'2008-12-10 13:06:27',
'2009-12-18 10:42:29',
'2011-12-12 16:39:33',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_date_query_month_expecting_noresults() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'month' => 8,
),
),
) );
$this->assertCount( 0, $posts );
}
public function test_date_query_week_expecting_results() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'week' => 1,
),
),
) );
$expected_dates = array(
'2004-01-03 08:54:10',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_date_query_week_expecting_noresults() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'week' => 10,
),
),
) );
$this->assertCount( 0, $posts );
}
public function test_date_query_day_expecting_results() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'day' => 17,
),
),
) );
$expected_dates = array(
'2005-02-17 00:00:15',
'2010-06-17 17:09:30',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_date_query_day_expecting_noresults() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'day' => 19,
),
),
) );
$this->assertCount( 0, $posts );
}
public function test_date_query_dayofweek_expecting_results() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'dayofweek' => 7,
),
),
) );
$expected_dates = array(
'1984-07-28 19:28:56',
'2004-01-03 08:54:10',
'2004-05-22 12:34:12',
'2005-12-31 23:59:20',
'2008-03-29 09:04:25',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_date_query_hour_expecting_results() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'hour' => 13,
),
),
) );
$expected_dates = array(
'2008-12-10 13:06:27',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_date_query_hour_expecting_noresults() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'hour' => 2,
),
),
) );
$this->assertCount( 0, $posts );
}
public function test_date_query_minute_expecting_results() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'minute' => 56,
),
),
) );
$expected_dates = array(
'2011-07-04 01:56:32',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_date_query_minute_expecting_noresults() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'minute' => 2,
),
),
) );
$this->assertCount( 0, $posts );
}
public function test_date_query_second_expecting_results() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'second' => 21,
),
),
) );
$expected_dates = array(
'2007-01-22 03:49:21',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_date_query_second_expecting_noresults() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'second' => 2,
),
),
) );
$this->assertCount( 0, $posts );
}
public function test_date_query_between_two_times() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'hour' => 9,
'minute' => 0,
'compare' => '>=',
),
array(
'hour' => '17',
'minute' => '0',
'compare' => '<=',
),
),
) );
$expected_dates = array(
'1972-05-24 14:53:45',
'2004-05-22 12:34:12',
'2008-03-29 09:04:25',
'2008-07-15 11:32:26',
'2008-12-10 13:06:27',
'2009-12-18 10:42:29',
'2011-02-23 12:12:31',
'2011-12-12 16:39:33',
'2012-06-13 14:03:34',
'2025-04-20 10:13:00',
'2025-04-20 10:13:01',
'2025-05-20 10:13:01',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_date_query_relation_or() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'hour' => 14,
),
array(
'minute' => 34,
),
'relation' => 'OR',
),
) );
$expected_dates = array(
'1972-05-24 14:53:45',
'2004-05-22 12:34:12',
'2012-06-13 14:03:34',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
public function test_date_query_compare_greater_than_or_equal_to() {
$posts = $this->_get_query_result( array(
'date_query' => array(
array(
'hour' => 14,
'minute' => 34,
),
'compare' => '>=',
),
) );
$expected_dates = array(
'1972-05-24 14:53:45',
'1984-07-28 19:28:56',
'2003-05-27 22:45:07',
'2005-12-31 23:59:20',
'2007-05-16 17:32:22',
'2009-06-11 21:30:28',
'2010-06-17 17:09:30',
'2011-12-12 16:39:33',
);
$this->assertEquals( $expected_dates, wp_list_pluck( $posts, 'post_date' ) );
}
}