3 * Class for generating SQL clauses that filter a primary query according to date.
5 * `WP_Date_Query` is a helper that allows primary query classes, such as {@see WP_Query},
6 * to filter their results by date columns, by generating `WHERE` subclauses to be attached
7 * to the primary SQL query string.
9 * Attempting to filter by an invalid date value (eg month=13) will generate SQL that will
10 * return no results. In these cases, a _doing_it_wrong() error notice is also thrown.
11 * See {@link WP_Date_Query::validate_date_values()}.
13 * @link https://codex.wordpress.org/Function_Reference/WP_Query Codex page.
19 * Array of date queries.
21 * See {@see WP_Date_Query::__construct()} for information on date query arguments.
27 public $queries = array();
30 * The default relation between top-level queries. Can be either 'AND' or 'OR'.
36 public $relation = 'AND';
39 * The column to query against. Can be changed via the query arguments.
45 public $column = 'post_date';
48 * The value comparison operator. Can be changed via the query arguments.
54 public $compare = '=';
57 * Supported time-related parameter keys.
63 public $time_keys = array( 'after', 'before', 'year', 'month', 'monthnum', 'week', 'w', 'dayofyear', 'day', 'dayofweek', 'dayofweek_iso', 'hour', 'minute', 'second' );
68 * Time-related parameters that normally require integer values ('year', 'month', 'week', 'dayofyear', 'day',
69 * 'dayofweek', 'dayofweek_iso', 'hour', 'minute', 'second') accept arrays of integers for some values of
70 * 'compare'. When 'compare' is 'IN' or 'NOT IN', arrays are accepted; when 'compare' is 'BETWEEN' or 'NOT
71 * BETWEEN', arrays of two valid values are required. See individual argument descriptions for accepted values.
74 * @since 4.0.0 The $inclusive logic was updated to include all times within the date range.
75 * @since 4.1.0 Introduced 'dayofweek_iso' time type parameter.
78 * @param array $date_query {
79 * Array of date query clauses.
82 * @type string $column Optional. The column to query against. If undefined, inherits the value of
83 * the `$default_column` parameter. Accepts 'post_date', 'post_date_gmt',
84 * 'post_modified','post_modified_gmt', 'comment_date', 'comment_date_gmt'.
85 * Default 'post_date'.
86 * @type string $compare Optional. The comparison operator. Accepts '=', '!=', '>', '>=', '<', '<=',
87 * 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN'. Default '='.
88 * @type string $relation Optional. The boolean relationship between the date queries. Accepts 'OR' or 'AND'.
91 * Optional. An array of first-order clause parameters, or another fully-formed date query.
93 * @type string|array $before {
94 * Optional. Date to retrieve posts before. Accepts `strtotime()`-compatible string,
95 * or array of 'year', 'month', 'day' values.
97 * @type string $year The four-digit year. Default empty. Accepts any four-digit year.
98 * @type string $month Optional when passing array.The month of the year.
99 * Default (string:empty)|(array:1). Accepts numbers 1-12.
100 * @type string $day Optional when passing array.The day of the month.
101 * Default (string:empty)|(array:1). Accepts numbers 1-31.
103 * @type string|array $after {
104 * Optional. Date to retrieve posts after. Accepts `strtotime()`-compatible string,
105 * or array of 'year', 'month', 'day' values.
107 * @type string $year The four-digit year. Accepts any four-digit year. Default empty.
108 * @type string $month Optional when passing array. The month of the year. Accepts numbers 1-12.
109 * Default (string:empty)|(array:12).
110 * @type string $day Optional when passing array.The day of the month. Accepts numbers 1-31.
111 * Default (string:empty)|(array:last day of month).
113 * @type string $column Optional. Used to add a clause comparing a column other than the
114 * column specified in the top-level `$column` parameter. Accepts
115 * 'post_date', 'post_date_gmt', 'post_modified', 'post_modified_gmt',
116 * 'comment_date', 'comment_date_gmt'. Default is the value of
117 * top-level `$column`.
118 * @type string $compare Optional. The comparison operator. Accepts '=', '!=', '>', '>=',
119 * '<', '<=', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN'. 'IN',
120 * 'NOT IN', 'BETWEEN', and 'NOT BETWEEN'. Comparisons support
121 * arrays in some time-related parameters. Default '='.
122 * @type bool $inclusive Optional. Include results from dates specified in 'before' or
123 * 'after'. Default false.
124 * @type int|array $year Optional. The four-digit year number. Accepts any four-digit year
125 * or an array of years if `$compare` supports it. Default empty.
126 * @type int|array $month Optional. The two-digit month number. Accepts numbers 1-12 or an
127 * array of valid numbers if `$compare` supports it. Default empty.
128 * @type int|array $week Optional. The week number of the year. Accepts numbers 0-53 or an
129 * array of valid numbers if `$compare` supports it. Default empty.
130 * @type int|array $dayofyear Optional. The day number of the year. Accepts numbers 1-366 or an
131 * array of valid numbers if `$compare` supports it.
132 * @type int|array $day Optional. The day of the month. Accepts numbers 1-31 or an array
133 * of valid numbers if `$compare` supports it. Default empty.
134 * @type int|array $dayofweek Optional. The day number of the week. Accepts numbers 1-7 (1 is
135 * Sunday) or an array of valid numbers if `$compare` supports it.
137 * @type int|array $dayofweek_iso Optional. The day number of the week (ISO). Accepts numbers 1-7
138 * (1 is Monday) or an array of valid numbers if `$compare` supports it.
140 * @type int|array $hour Optional. The hour of the day. Accepts numbers 0-23 or an array
141 * of valid numbers if `$compare` supports it. Default empty.
142 * @type int|array $minute Optional. The minute of the hour. Accepts numbers 0-60 or an array
143 * of valid numbers if `$compare` supports it. Default empty.
144 * @type int|array $second Optional. The second of the minute. Accepts numbers 0-60 or an
145 * array of valid numbers if `$compare` supports it. Default empty.
149 * @param array $default_column Optional. Default column to query against. Default 'post_date'.
150 * Accepts 'post_date', 'post_date_gmt', 'post_modified', 'post_modified_gmt',
151 * 'comment_date', 'comment_date_gmt'.
153 public function __construct( $date_query, $default_column = 'post_date' ) {
155 if ( isset( $date_query['relation'] ) && 'OR' === strtoupper( $date_query['relation'] ) ) {
156 $this->relation = 'OR';
158 $this->relation = 'AND';
161 if ( ! is_array( $date_query ) ) {
165 // Support for passing time-based keys in the top level of the $date_query array.
166 if ( ! isset( $date_query[0] ) && ! empty( $date_query ) ) {
167 $date_query = array( $date_query );
170 if ( empty( $date_query ) ) {
174 if ( ! empty( $date_query['column'] ) ) {
175 $date_query['column'] = esc_sql( $date_query['column'] );
177 $date_query['column'] = esc_sql( $default_column );
180 $this->column = $this->validate_column( $this->column );
182 $this->compare = $this->get_compare( $date_query );
184 $this->queries = $this->sanitize_query( $date_query );
188 * Recursive-friendly query sanitizer.
190 * Ensures that each query-level clause has a 'relation' key, and that
191 * each first-order clause contains all the necessary keys from
197 * @param array $queries
198 * @param array $parent_query
200 * @return array Sanitized queries.
202 public function sanitize_query( $queries, $parent_query = null ) {
203 $cleaned_query = array();
206 'column' => 'post_date',
211 // Numeric keys should always have array values.
212 foreach ( $queries as $qkey => $qvalue ) {
213 if ( is_numeric( $qkey ) && ! is_array( $qvalue ) ) {
214 unset( $queries[ $qkey ] );
218 // Each query should have a value for each default key. Inherit from the parent when possible.
219 foreach ( $defaults as $dkey => $dvalue ) {
220 if ( isset( $queries[ $dkey ] ) ) {
224 if ( isset( $parent_query[ $dkey ] ) ) {
225 $queries[ $dkey ] = $parent_query[ $dkey ];
227 $queries[ $dkey ] = $dvalue;
231 // Validate the dates passed in the query.
232 if ( $this->is_first_order_clause( $queries ) ) {
233 $this->validate_date_values( $queries );
236 foreach ( $queries as $key => $q ) {
237 if ( ! is_array( $q ) || in_array( $key, $this->time_keys, true ) ) {
238 // This is a first-order query. Trust the values and sanitize when building SQL.
239 $cleaned_query[ $key ] = $q;
241 // Any array without a time key is another query, so we recurse.
242 $cleaned_query[] = $this->sanitize_query( $q, $queries );
246 return $cleaned_query;
250 * Determine whether this is a first-order clause.
252 * Checks to see if the current clause has any time-related keys.
253 * If so, it's first-order.
255 * @param array $query Query clause.
256 * @return bool True if this is a first-order clause.
258 protected function is_first_order_clause( $query ) {
259 $time_keys = array_intersect( $this->time_keys, array_keys( $query ) );
260 return ! empty( $time_keys );
264 * Determines and validates what comparison operator to use.
269 * @param array $query A date query or a date subquery.
270 * @return string The comparison operator.
272 public function get_compare( $query ) {
273 if ( ! empty( $query['compare'] ) && in_array( $query['compare'], array( '=', '!=', '>', '>=', '<', '<=', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) )
274 return strtoupper( $query['compare'] );
276 return $this->compare;
280 * Validates the given date_query values and triggers errors if something is not valid.
282 * Note that date queries with invalid date ranges are allowed to
283 * continue (though of course no items will be found for impossible dates).
284 * This method only generates debug notices for these cases.
289 * @param array $date_query The date_query array.
290 * @return bool True if all values in the query are valid, false if one or more fail.
292 public function validate_date_values( $date_query = array() ) {
293 if ( empty( $date_query ) ) {
300 * Validate 'before' and 'after' up front, then let the
301 * validation routine continue to be sure that all invalid
302 * values generate errors too.
304 if ( array_key_exists( 'before', $date_query ) && is_array( $date_query['before'] ) ){
305 $valid = $this->validate_date_values( $date_query['before'] );
308 if ( array_key_exists( 'after', $date_query ) && is_array( $date_query['after'] ) ){
309 $valid = $this->validate_date_values( $date_query['after'] );
312 // Array containing all min-max checks.
313 $min_max_checks = array();
316 if ( array_key_exists( 'year', $date_query ) ) {
318 * If a year exists in the date query, we can use it to get the days.
319 * If multiple years are provided (as in a BETWEEN), use the first one.
321 if ( is_array( $date_query['year'] ) ) {
322 $_year = reset( $date_query['year'] );
324 $_year = $date_query['year'];
327 $max_days_of_year = date( 'z', mktime( 0, 0, 0, 12, 31, $_year ) ) + 1;
329 // otherwise we use the max of 366 (leap-year)
330 $max_days_of_year = 366;
333 $min_max_checks['dayofyear'] = array(
335 'max' => $max_days_of_year
339 $min_max_checks['dayofweek'] = array(
345 $min_max_checks['dayofweek_iso'] = array(
351 $min_max_checks['month'] = array(
357 if ( isset( $_year ) ) {
359 * If we have a specific year, use it to calculate number of weeks.
360 * Note: the number of weeks in a year is the date in which Dec 28 appears.
362 $week_count = date( 'W', mktime( 0, 0, 0, 12, 28, $_year ) );
365 // Otherwise set the week-count to a maximum of 53.
369 $min_max_checks['week'] = array(
375 $min_max_checks['day'] = array(
381 $min_max_checks['hour'] = array(
387 $min_max_checks['minute'] = array(
392 // Seconds per minute.
393 $min_max_checks['second'] = array(
398 // Concatenate and throw a notice for each invalid value.
399 foreach ( $min_max_checks as $key => $check ) {
400 if ( ! array_key_exists( $key, $date_query ) ) {
404 // Throw a notice for each failing value.
405 foreach ( (array) $date_query[ $key ] as $_value ) {
406 $is_between = $_value >= $check['min'] && $_value <= $check['max'];
408 if ( ! is_numeric( $_value ) || ! $is_between ) {
410 /* translators: Date query invalid date message: 1: invalid value, 2: type of value, 3: minimum valid value, 4: maximum valid value */
411 __( 'Invalid value %1$s for %2$s. Expected value should be between %3$s and %4$s.' ),
412 '<code>' . esc_html( $_value ) . '</code>',
413 '<code>' . esc_html( $key ) . '</code>',
414 '<code>' . esc_html( $check['min'] ) . '</code>',
415 '<code>' . esc_html( $check['max'] ) . '</code>'
418 _doing_it_wrong( __CLASS__, $error, '4.1.0' );
425 // If we already have invalid date messages, don't bother running through checkdate().
430 $day_month_year_error_msg = '';
432 $day_exists = array_key_exists( 'day', $date_query ) && is_numeric( $date_query['day'] );
433 $month_exists = array_key_exists( 'month', $date_query ) && is_numeric( $date_query['month'] );
434 $year_exists = array_key_exists( 'year', $date_query ) && is_numeric( $date_query['year'] );
436 if ( $day_exists && $month_exists && $year_exists ) {
437 // 1. Checking day, month, year combination.
438 if ( ! wp_checkdate( $date_query['month'], $date_query['day'], $date_query['year'], sprintf( '%s-%s-%s', $date_query['year'], $date_query['month'], $date_query['day'] ) ) ) {
439 /* translators: 1: year, 2: month, 3: day of month */
440 $day_month_year_error_msg = sprintf(
441 __( 'The following values do not describe a valid date: year %1$s, month %2$s, day %3$s.' ),
442 '<code>' . esc_html( $date_query['year'] ) . '</code>',
443 '<code>' . esc_html( $date_query['month'] ) . '</code>',
444 '<code>' . esc_html( $date_query['day'] ) . '</code>'
450 } elseif ( $day_exists && $month_exists ) {
452 * 2. checking day, month combination
453 * We use 2012 because, as a leap year, it's the most permissive.
455 if ( ! wp_checkdate( $date_query['month'], $date_query['day'], 2012, sprintf( '2012-%s-%s', $date_query['month'], $date_query['day'] ) ) ) {
456 /* translators: 1: month, 2: day of month */
457 $day_month_year_error_msg = sprintf(
458 __( 'The following values do not describe a valid date: month %1$s, day %2$s.' ),
459 '<code>' . esc_html( $date_query['month'] ) . '</code>',
460 '<code>' . esc_html( $date_query['day'] ) . '</code>'
467 if ( ! empty( $day_month_year_error_msg ) ) {
468 _doing_it_wrong( __CLASS__, $day_month_year_error_msg, '4.1.0' );
475 * Validates a column name parameter.
477 * Column names without a table prefix (like 'post_date') are checked against a whitelist of
478 * known tables, and then, if found, have a table prefix (such as 'wp_posts.') prepended.
479 * Prefixed column names (such as 'wp_posts.post_date') bypass this whitelist check,
480 * and are only sanitized to remove illegal characters.
485 * @param string $column The user-supplied column name.
486 * @return string A validated column name value.
488 public function validate_column( $column ) {
491 $valid_columns = array(
492 'post_date', 'post_date_gmt', 'post_modified',
493 'post_modified_gmt', 'comment_date', 'comment_date_gmt',
497 // Attempt to detect a table prefix.
498 if ( false === strpos( $column, '.' ) ) {
500 * Filter the list of valid date query columns.
503 * @since 4.1.0 Added 'user_registered' to the default recognized columns.
505 * @param array $valid_columns An array of valid date query columns. Defaults
506 * are 'post_date', 'post_date_gmt', 'post_modified',
507 * 'post_modified_gmt', 'comment_date', 'comment_date_gmt',
510 if ( ! in_array( $column, apply_filters( 'date_query_valid_columns', $valid_columns ) ) ) {
511 $column = 'post_date';
514 $known_columns = array(
515 $wpdb->posts => array(
521 $wpdb->comments => array(
525 $wpdb->users => array(
530 // If it's a known column name, add the appropriate table prefix.
531 foreach ( $known_columns as $table_name => $table_columns ) {
532 if ( in_array( $column, $table_columns ) ) {
533 $column = $table_name . '.' . $column;
540 // Remove unsafe characters.
541 return preg_replace( '/[^a-zA-Z0-9_$\.]/', '', $column );
545 * Generate WHERE clause to be appended to a main query.
550 * @return string MySQL WHERE clause.
552 public function get_sql() {
553 $sql = $this->get_sql_clauses();
555 $where = $sql['where'];
558 * Filter the date query WHERE clause.
562 * @param string $where WHERE clause of the date query.
563 * @param WP_Date_Query $this The WP_Date_Query instance.
565 return apply_filters( 'get_date_sql', $where, $this );
569 * Generate SQL clauses to be appended to a main query.
571 * Called by the public {@see WP_Date_Query::get_sql()}, this method
572 * is abstracted out to maintain parity with the other Query classes.
578 * Array containing JOIN and WHERE SQL clauses to append to the main query.
580 * @type string $join SQL fragment to append to the main JOIN clause.
581 * @type string $where SQL fragment to append to the main WHERE clause.
584 protected function get_sql_clauses() {
585 $sql = $this->get_sql_for_query( $this->queries );
587 if ( ! empty( $sql['where'] ) ) {
588 $sql['where'] = ' AND ' . $sql['where'];
595 * Generate SQL clauses for a single query array.
597 * If nested subqueries are found, this method recurses the tree to
598 * produce the properly nested SQL.
603 * @param array $query Query to parse.
604 * @param int $depth Optional. Number of tree levels deep we currently are.
605 * Used to calculate indentation. Default 0.
607 * Array containing JOIN and WHERE SQL clauses to append to a single query array.
609 * @type string $join SQL fragment to append to the main JOIN clause.
610 * @type string $where SQL fragment to append to the main WHERE clause.
613 protected function get_sql_for_query( $query, $depth = 0 ) {
625 for ( $i = 0; $i < $depth; $i++ ) {
629 foreach ( $query as $key => $clause ) {
630 if ( 'relation' === $key ) {
631 $relation = $query['relation'];
632 } elseif ( is_array( $clause ) ) {
634 // This is a first-order clause.
635 if ( $this->is_first_order_clause( $clause ) ) {
636 $clause_sql = $this->get_sql_for_clause( $clause, $query );
638 $where_count = count( $clause_sql['where'] );
639 if ( ! $where_count ) {
640 $sql_chunks['where'][] = '';
641 } elseif ( 1 === $where_count ) {
642 $sql_chunks['where'][] = $clause_sql['where'][0];
644 $sql_chunks['where'][] = '( ' . implode( ' AND ', $clause_sql['where'] ) . ' )';
647 $sql_chunks['join'] = array_merge( $sql_chunks['join'], $clause_sql['join'] );
648 // This is a subquery, so we recurse.
650 $clause_sql = $this->get_sql_for_query( $clause, $depth + 1 );
652 $sql_chunks['where'][] = $clause_sql['where'];
653 $sql_chunks['join'][] = $clause_sql['join'];
658 // Filter to remove empties.
659 $sql_chunks['join'] = array_filter( $sql_chunks['join'] );
660 $sql_chunks['where'] = array_filter( $sql_chunks['where'] );
662 if ( empty( $relation ) ) {
666 // Filter duplicate JOIN clauses and combine into a single string.
667 if ( ! empty( $sql_chunks['join'] ) ) {
668 $sql['join'] = implode( ' ', array_unique( $sql_chunks['join'] ) );
671 // Generate a single WHERE clause with proper brackets and indentation.
672 if ( ! empty( $sql_chunks['where'] ) ) {
673 $sql['where'] = '( ' . "\n " . $indent . implode( ' ' . "\n " . $indent . $relation . ' ' . "\n " . $indent, $sql_chunks['where'] ) . "\n" . $indent . ')';
680 * Turns a single date clause into pieces for a WHERE clause.
682 * A wrapper for get_sql_for_clause(), included here for backward
683 * compatibility while retaining the naming convention across Query classes.
688 * @param array $query Date query arguments.
690 * Array containing JOIN and WHERE SQL clauses to append to the main query.
692 * @type string $join SQL fragment to append to the main JOIN clause.
693 * @type string $where SQL fragment to append to the main WHERE clause.
696 protected function get_sql_for_subquery( $query ) {
697 return $this->get_sql_for_clause( $query, '' );
701 * Turns a first-order date query into SQL for a WHERE clause.
706 * @param array $query Date query clause.
707 * @param array $parent_query Parent query of the current date query.
709 * Array containing JOIN and WHERE SQL clauses to append to the main query.
711 * @type string $join SQL fragment to append to the main JOIN clause.
712 * @type string $where SQL fragment to append to the main WHERE clause.
715 protected function get_sql_for_clause( $query, $parent_query ) {
718 // The sub-parts of a $where part.
719 $where_parts = array();
721 $column = ( ! empty( $query['column'] ) ) ? esc_sql( $query['column'] ) : $this->column;
723 $column = $this->validate_column( $column );
725 $compare = $this->get_compare( $query );
727 $inclusive = ! empty( $query['inclusive'] );
729 // Assign greater- and less-than values.
739 if ( ! empty( $query['after'] ) )
740 $where_parts[] = $wpdb->prepare( "$column $gt %s", $this->build_mysql_datetime( $query['after'], ! $inclusive ) );
742 if ( ! empty( $query['before'] ) )
743 $where_parts[] = $wpdb->prepare( "$column $lt %s", $this->build_mysql_datetime( $query['before'], $inclusive ) );
745 // Specific value queries.
747 if ( isset( $query['year'] ) && $value = $this->build_value( $compare, $query['year'] ) )
748 $where_parts[] = "YEAR( $column ) $compare $value";
750 if ( isset( $query['month'] ) && $value = $this->build_value( $compare, $query['month'] ) ) {
751 $where_parts[] = "MONTH( $column ) $compare $value";
752 } elseif ( isset( $query['monthnum'] ) && $value = $this->build_value( $compare, $query['monthnum'] ) ) {
753 $where_parts[] = "MONTH( $column ) $compare $value";
755 if ( isset( $query['week'] ) && false !== ( $value = $this->build_value( $compare, $query['week'] ) ) ) {
756 $where_parts[] = _wp_mysql_week( $column ) . " $compare $value";
757 } elseif ( isset( $query['w'] ) && false !== ( $value = $this->build_value( $compare, $query['w'] ) ) ) {
758 $where_parts[] = _wp_mysql_week( $column ) . " $compare $value";
760 if ( isset( $query['dayofyear'] ) && $value = $this->build_value( $compare, $query['dayofyear'] ) )
761 $where_parts[] = "DAYOFYEAR( $column ) $compare $value";
763 if ( isset( $query['day'] ) && $value = $this->build_value( $compare, $query['day'] ) )
764 $where_parts[] = "DAYOFMONTH( $column ) $compare $value";
766 if ( isset( $query['dayofweek'] ) && $value = $this->build_value( $compare, $query['dayofweek'] ) )
767 $where_parts[] = "DAYOFWEEK( $column ) $compare $value";
769 if ( isset( $query['dayofweek_iso'] ) && $value = $this->build_value( $compare, $query['dayofweek_iso'] ) )
770 $where_parts[] = "WEEKDAY( $column ) + 1 $compare $value";
772 if ( isset( $query['hour'] ) || isset( $query['minute'] ) || isset( $query['second'] ) ) {
774 foreach ( array( 'hour', 'minute', 'second' ) as $unit ) {
775 if ( ! isset( $query[ $unit ] ) ) {
776 $query[ $unit ] = null;
780 if ( $time_query = $this->build_time_query( $column, $compare, $query['hour'], $query['minute'], $query['second'] ) ) {
781 $where_parts[] = $time_query;
786 * Return an array of 'join' and 'where' for compatibility
787 * with other query classes.
790 'where' => $where_parts,
796 * Builds and validates a value string based on the comparison operator.
801 * @param string $compare The compare operator to use
802 * @param string|array $value The value
803 * @return string|false|int The value to be used in SQL or false on error.
805 public function build_value( $compare, $value ) {
806 if ( ! isset( $value ) )
809 switch ( $compare ) {
812 $value = (array) $value;
814 // Remove non-numeric values.
815 $value = array_filter( $value, 'is_numeric' );
817 if ( empty( $value ) ) {
821 return '(' . implode( ',', array_map( 'intval', $value ) ) . ')';
825 if ( ! is_array( $value ) || 2 != count( $value ) ) {
826 $value = array( $value, $value );
828 $value = array_values( $value );
831 // If either value is non-numeric, bail.
832 foreach ( $value as $v ) {
833 if ( ! is_numeric( $v ) ) {
838 $value = array_map( 'intval', $value );
840 return $value[0] . ' AND ' . $value[1];
843 if ( ! is_numeric( $value ) ) {
852 * Builds a MySQL format date/time based on some query parameters.
854 * You can pass an array of values (year, month, etc.) with missing parameter values being defaulted to
855 * either the maximum or minimum values (controlled by the $default_to parameter). Alternatively you can
856 * pass a string that will be run through strtotime().
861 * @param string|array $datetime An array of parameters or a strotime() string
862 * @param bool $default_to_max Whether to round up incomplete dates. Supported by values
863 * of $datetime that are arrays, or string values that are a
864 * subset of MySQL date format ('Y', 'Y-m', 'Y-m-d', 'Y-m-d H:i').
866 * @return string|false A MySQL format date/time or false on failure
868 public function build_mysql_datetime( $datetime, $default_to_max = false ) {
869 $now = current_time( 'timestamp' );
871 if ( ! is_array( $datetime ) ) {
874 * Try to parse some common date formats, so we can detect
875 * the level of precision and support the 'inclusive' parameter.
877 if ( preg_match( '/^(\d{4})$/', $datetime, $matches ) ) {
880 'year' => intval( $matches[1] ),
883 } elseif ( preg_match( '/^(\d{4})\-(\d{2})$/', $datetime, $matches ) ) {
886 'year' => intval( $matches[1] ),
887 'month' => intval( $matches[2] ),
890 } elseif ( preg_match( '/^(\d{4})\-(\d{2})\-(\d{2})$/', $datetime, $matches ) ) {
893 'year' => intval( $matches[1] ),
894 'month' => intval( $matches[2] ),
895 'day' => intval( $matches[3] ),
898 } elseif ( preg_match( '/^(\d{4})\-(\d{2})\-(\d{2}) (\d{2}):(\d{2})$/', $datetime, $matches ) ) {
901 'year' => intval( $matches[1] ),
902 'month' => intval( $matches[2] ),
903 'day' => intval( $matches[3] ),
904 'hour' => intval( $matches[4] ),
905 'minute' => intval( $matches[5] ),
909 // If no match is found, we don't support default_to_max.
910 if ( ! is_array( $datetime ) ) {
911 // @todo Timezone issues here possibly
912 return gmdate( 'Y-m-d H:i:s', strtotime( $datetime, $now ) );
916 $datetime = array_map( 'absint', $datetime );
918 if ( ! isset( $datetime['year'] ) )
919 $datetime['year'] = gmdate( 'Y', $now );
921 if ( ! isset( $datetime['month'] ) )
922 $datetime['month'] = ( $default_to_max ) ? 12 : 1;
924 if ( ! isset( $datetime['day'] ) )
925 $datetime['day'] = ( $default_to_max ) ? (int) date( 't', mktime( 0, 0, 0, $datetime['month'], 1, $datetime['year'] ) ) : 1;
927 if ( ! isset( $datetime['hour'] ) )
928 $datetime['hour'] = ( $default_to_max ) ? 23 : 0;
930 if ( ! isset( $datetime['minute'] ) )
931 $datetime['minute'] = ( $default_to_max ) ? 59 : 0;
933 if ( ! isset( $datetime['second'] ) )
934 $datetime['second'] = ( $default_to_max ) ? 59 : 0;
936 return sprintf( '%04d-%02d-%02d %02d:%02d:%02d', $datetime['year'], $datetime['month'], $datetime['day'], $datetime['hour'], $datetime['minute'], $datetime['second'] );
940 * Builds a query string for comparing time values (hour, minute, second).
942 * If just hour, minute, or second is set than a normal comparison will be done.
943 * However if multiple values are passed, a pseudo-decimal time will be created
944 * in order to be able to accurately compare against.
949 * @param string $column The column to query against. Needs to be pre-validated!
950 * @param string $compare The comparison operator. Needs to be pre-validated!
951 * @param int|null $hour Optional. An hour value (0-23).
952 * @param int|null $minute Optional. A minute value (0-59).
953 * @param int|null $second Optional. A second value (0-59).
954 * @return string|false A query part or false on failure.
956 public function build_time_query( $column, $compare, $hour = null, $minute = null, $second = null ) {
959 // Have to have at least one
960 if ( ! isset( $hour ) && ! isset( $minute ) && ! isset( $second ) )
963 // Complex combined queries aren't supported for multi-value queries
964 if ( in_array( $compare, array( 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) ) {
967 if ( isset( $hour ) && false !== ( $value = $this->build_value( $compare, $hour ) ) )
968 $return[] = "HOUR( $column ) $compare $value";
970 if ( isset( $minute ) && false !== ( $value = $this->build_value( $compare, $minute ) ) )
971 $return[] = "MINUTE( $column ) $compare $value";
973 if ( isset( $second ) && false !== ( $value = $this->build_value( $compare, $second ) ) )
974 $return[] = "SECOND( $column ) $compare $value";
976 return implode( ' AND ', $return );
979 // Cases where just one unit is set
980 if ( isset( $hour ) && ! isset( $minute ) && ! isset( $second ) && false !== ( $value = $this->build_value( $compare, $hour ) ) ) {
981 return "HOUR( $column ) $compare $value";
982 } elseif ( ! isset( $hour ) && isset( $minute ) && ! isset( $second ) && false !== ( $value = $this->build_value( $compare, $minute ) ) ) {
983 return "MINUTE( $column ) $compare $value";
984 } elseif ( ! isset( $hour ) && ! isset( $minute ) && isset( $second ) && false !== ( $value = $this->build_value( $compare, $second ) ) ) {
985 return "SECOND( $column ) $compare $value";
988 // Single units were already handled. Since hour & second isn't allowed, minute must to be set.
989 if ( ! isset( $minute ) )
992 $format = $time = '';
995 if ( null !== $hour ) {
997 $time .= sprintf( '%02d', $hour ) . '.';
1005 $time .= sprintf( '%02d', $minute );
1007 if ( isset( $second ) ) {
1009 $time .= sprintf( '%02d', $second );
1012 return $wpdb->prepare( "DATE_FORMAT( $column, %s ) $compare %f", $format, $time );