wp-includes/date.php

   1 <?php
   2 /**
   3  * Class for generating SQL clauses that filter a primary query according to date.
   4  *
   5  * WP_Date_Query is a helper that allows primary query classes, such as WP_Query, to filter
   6  * their results by date columns, by generating `WHERE` subclauses to be attached to the
   7  * primary SQL query string.
   8  *
   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 WP_Date_Query::validate_date_values().
  12  *
  13  * @link https://codex.wordpress.org/Function_Reference/WP_Query Codex page.
  14  *
  15  * @since 3.7.0
  16  */
  17 class WP_Date_Query {
  18         /**
  19          * Array of date queries.
  20          *
  21          * See WP_Date_Query::__construct() for information on date query arguments.
  22          *
  23          * @since 3.7.0
  24          * @access public
  25          * @var array
  26          */
  27         public $queries = array();
  28
  29         /**
  30          * The default relation between top-level queries. Can be either 'AND' or 'OR'.
  31          *
  32          * @since 3.7.0
  33          * @access public
  34          * @var string
  35          */
  36         public $relation = 'AND';
  37
  38         /**
  39          * The column to query against. Can be changed via the query arguments.
  40          *
  41          * @since 3.7.0
  42          * @access public
  43          * @var string
  44          */
  45         public $column = 'post_date';
  46
  47         /**
  48          * The value comparison operator. Can be changed via the query arguments.
  49          *
  50          * @since 3.7.0
  51          * @access public
  52          * @var array
  53          */
  54         public $compare = '=';
  55
  56         /**
  57          * Supported time-related parameter keys.
  58          *
  59          * @since 4.1.0
  60          * @access public
  61          * @var array
  62          */
  63         public $time_keys = array( 'after', 'before', 'year', 'month', 'monthnum', 'week', 'w', 'dayofyear', 'day', 'dayofweek', 'dayofweek_iso', 'hour', 'minute', 'second' );
  64
  65         /**
  66          * Constructor.
  67          *
  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.
  72          *
  73          * @since 3.7.0
  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.
  76          * @access public
  77          *
  78          * @param array $date_query {
  79          *     Array of date query clauses.
  80          *
  81          *     @type array {
  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'.
  89          *                                Default 'OR'.
  90          *         @type array {
  91          *             Optional. An array of first-order clause parameters, or another fully-formed date query.
  92          *
  93          *             @type string|array $before {
  94          *                 Optional. Date to retrieve posts before. Accepts `strtotime()`-compatible string,
  95          *                 or array of 'year', 'month', 'day' values.
  96          *
  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.
 102          *             }
 103          *             @type string|array $after {
 104          *                 Optional. Date to retrieve posts after. Accepts `strtotime()`-compatible string,
 105          *                 or array of 'year', 'month', 'day' values.
 106          *
 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).
 112          *             }
 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.
 136          *                                               Default empty.
 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.
 139          *                                               Default empty.
 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.
 146          *         }
 147          *     }
 148          * }
 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'.
 152          */
 153         public function __construct( $date_query, $default_column = 'post_date' ) {
 154                 if ( isset( $date_query['relation'] ) && 'OR' === strtoupper( $date_query['relation'] ) ) {
 155                         $this->relation = 'OR';
 156                 } else {
 157                         $this->relation = 'AND';
 158                 }
 159
 160                 if ( ! is_array( $date_query ) ) {
 161                         return;
 162                 }
 163
 164                 // Support for passing time-based keys in the top level of the $date_query array.
 165                 if ( ! isset( $date_query[0] ) && ! empty( $date_query ) ) {
 166                         $date_query = array( $date_query );
 167                 }
 168
 169                 if ( empty( $date_query ) ) {
 170                         return;
 171                 }
 172
 173                 if ( ! empty( $date_query['column'] ) ) {
 174                         $date_query['column'] = esc_sql( $date_query['column'] );
 175                 } else {
 176                         $date_query['column'] = esc_sql( $default_column );
 177                 }
 178
 179                 $this->column = $this->validate_column( $this->column );
 180
 181                 $this->compare = $this->get_compare( $date_query );
 182
 183                 $this->queries = $this->sanitize_query( $date_query );
 184         }
 185
 186         /**
 187          * Recursive-friendly query sanitizer.
 188          *
 189          * Ensures that each query-level clause has a 'relation' key, and that
 190          * each first-order clause contains all the necessary keys from
 191          * `$defaults`.
 192          *
 193          * @since 4.1.0
 194          * @access public
 195          *
 196          * @param array $queries
 197          * @param array $parent_query
 198          *
 199          * @return array Sanitized queries.
 200          */
 201         public function sanitize_query( $queries, $parent_query = null ) {
 202                 $cleaned_query = array();
 203
 204                 $defaults = array(
 205                         'column'   => 'post_date',
 206                         'compare'  => '=',
 207                         'relation' => 'AND',
 208                 );
 209
 210                 // Numeric keys should always have array values.
 211                 foreach ( $queries as $qkey => $qvalue ) {
 212                         if ( is_numeric( $qkey ) && ! is_array( $qvalue ) ) {
 213                                 unset( $queries[ $qkey ] );
 214                         }
 215                 }
 216
 217                 // Each query should have a value for each default key. Inherit from the parent when possible.
 218                 foreach ( $defaults as $dkey => $dvalue ) {
 219                         if ( isset( $queries[ $dkey ] ) ) {
 220                                 continue;
 221                         }
 222
 223                         if ( isset( $parent_query[ $dkey ] ) ) {
 224                                 $queries[ $dkey ] = $parent_query[ $dkey ];
 225                         } else {
 226                                 $queries[ $dkey ] = $dvalue;
 227                         }
 228                 }
 229
 230                 // Validate the dates passed in the query.
 231                 if ( $this->is_first_order_clause( $queries ) ) {
 232                         $this->validate_date_values( $queries );
 233                 }
 234
 235                 foreach ( $queries as $key => $q ) {
 236                         if ( ! is_array( $q ) || in_array( $key, $this->time_keys, true ) ) {
 237                                 // This is a first-order query. Trust the values and sanitize when building SQL.
 238                                 $cleaned_query[ $key ] = $q;
 239                         } else {
 240                                 // Any array without a time key is another query, so we recurse.
 241                                 $cleaned_query[] = $this->sanitize_query( $q, $queries );
 242                         }
 243                 }
 244
 245                 return $cleaned_query;
 246         }
 247
 248         /**
 249          * Determine whether this is a first-order clause.
 250          *
 251          * Checks to see if the current clause has any time-related keys.
 252          * If so, it's first-order.
 253          *
 254          * @param  array $query Query clause.
 255          * @return bool True if this is a first-order clause.
 256          */
 257         protected function is_first_order_clause( $query ) {
 258                 $time_keys = array_intersect( $this->time_keys, array_keys( $query ) );
 259                 return ! empty( $time_keys );
 260         }
 261
 262         /**
 263          * Determines and validates what comparison operator to use.
 264          *
 265          * @since 3.7.0
 266          * @access public
 267          *
 268          * @param array $query A date query or a date subquery.
 269          * @return string The comparison operator.
 270          */
 271         public function get_compare( $query ) {
 272                 if ( ! empty( $query['compare'] ) && in_array( $query['compare'], array( '=', '!=', '>', '>=', '<', '<=', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) )
 273                         return strtoupper( $query['compare'] );
 274
 275                 return $this->compare;
 276         }
 277
 278         /**
 279          * Validates the given date_query values and triggers errors if something is not valid.
 280          *
 281          * Note that date queries with invalid date ranges are allowed to
 282          * continue (though of course no items will be found for impossible dates).
 283          * This method only generates debug notices for these cases.
 284          *
 285          * @since  4.1.0
 286          * @access public
 287          *
 288          * @param  array $date_query The date_query array.
 289          * @return bool  True if all values in the query are valid, false if one or more fail.
 290          */
 291         public function validate_date_values( $date_query = array() ) {
 292                 if ( empty( $date_query ) ) {
 293                         return false;
 294                 }
 295
 296                 $valid = true;
 297
 298                 /*
 299                  * Validate 'before' and 'after' up front, then let the
 300                  * validation routine continue to be sure that all invalid
 301                  * values generate errors too.
 302                  */
 303                 if ( array_key_exists( 'before', $date_query ) && is_array( $date_query['before'] ) ){
 304                         $valid = $this->validate_date_values( $date_query['before'] );
 305                 }
 306
 307                 if ( array_key_exists( 'after', $date_query ) && is_array( $date_query['after'] ) ){
 308                         $valid = $this->validate_date_values( $date_query['after'] );
 309                 }
 310
 311                 // Array containing all min-max checks.
 312                 $min_max_checks = array();
 313
 314                 // Days per year.
 315                 if ( array_key_exists( 'year', $date_query ) ) {
 316                         /*
 317                          * If a year exists in the date query, we can use it to get the days.
 318                          * If multiple years are provided (as in a BETWEEN), use the first one.
 319                          */
 320                         if ( is_array( $date_query['year'] ) ) {
 321                                 $_year = reset( $date_query['year'] );
 322                         } else {
 323                                 $_year = $date_query['year'];
 324                         }
 325
 326                         $max_days_of_year = date( 'z', mktime( 0, 0, 0, 12, 31, $_year ) ) + 1;
 327                 } else {
 328                         // otherwise we use the max of 366 (leap-year)
 329                         $max_days_of_year = 366;
 330                 }
 331
 332                 $min_max_checks['dayofyear'] = array(
 333                         'min' => 1,
 334                         'max' => $max_days_of_year
 335                 );
 336
 337                 // Days per week.
 338                 $min_max_checks['dayofweek'] = array(
 339                         'min' => 1,
 340                         'max' => 7
 341                 );
 342
 343                 // Days per week.
 344                 $min_max_checks['dayofweek_iso'] = array(
 345                         'min' => 1,
 346                         'max' => 7
 347                 );
 348
 349                 // Months per year.
 350                 $min_max_checks['month'] = array(
 351                         'min' => 1,
 352                         'max' => 12
 353                 );
 354
 355                 // Weeks per year.
 356                 if ( isset( $_year ) ) {
 357                         /*
 358                          * If we have a specific year, use it to calculate number of weeks.
 359                          * Note: the number of weeks in a year is the date in which Dec 28 appears.
 360                          */
 361                         $week_count = date( 'W', mktime( 0, 0, 0, 12, 28, $_year ) );
 362
 363                 } else {
 364                         // Otherwise set the week-count to a maximum of 53.
 365                         $week_count = 53;
 366                 }
 367
 368                 $min_max_checks['week'] = array(
 369                         'min' => 1,
 370                         'max' => $week_count
 371                 );
 372
 373                 // Days per month.
 374                 $min_max_checks['day'] = array(
 375                         'min' => 1,
 376                         'max' => 31
 377                 );
 378
 379                 // Hours per day.
 380                 $min_max_checks['hour'] = array(
 381                         'min' => 0,
 382                         'max' => 23
 383                 );
 384
 385                 // Minutes per hour.
 386                 $min_max_checks['minute'] = array(
 387                         'min' => 0,
 388                         'max' => 59
 389                 );
 390
 391                 // Seconds per minute.
 392                 $min_max_checks['second'] = array(
 393                         'min' => 0,
 394                         'max' => 59
 395                 );
 396
 397                 // Concatenate and throw a notice for each invalid value.
 398                 foreach ( $min_max_checks as $key => $check ) {
 399                         if ( ! array_key_exists( $key, $date_query ) ) {
 400                                 continue;
 401                         }
 402
 403                         // Throw a notice for each failing value.
 404                         foreach ( (array) $date_query[ $key ] as $_value ) {
 405                                 $is_between = $_value >= $check['min'] && $_value <= $check['max'];
 406
 407                                 if ( ! is_numeric( $_value ) || ! $is_between ) {
 408                                         $error = sprintf(
 409                                                 /* translators: Date query invalid date message: 1: invalid value, 2: type of value, 3: minimum valid value, 4: maximum valid value */
 410                                                 __( 'Invalid value %1$s for %2$s. Expected value should be between %3$s and %4$s.' ),
 411                                                 '<code>' . esc_html( $_value ) . '</code>',
 412                                                 '<code>' . esc_html( $key ) . '</code>',
 413                                                 '<code>' . esc_html( $check['min'] ) . '</code>',
 414                                                 '<code>' . esc_html( $check['max'] ) . '</code>'
 415                                         );
 416
 417                                         _doing_it_wrong( __CLASS__, $error, '4.1.0' );
 418
 419                                         $valid = false;
 420                                 }
 421                         }
 422                 }
 423
 424                 // If we already have invalid date messages, don't bother running through checkdate().
 425                 if ( ! $valid ) {
 426                         return $valid;
 427                 }
 428
 429                 $day_month_year_error_msg = '';
 430
 431                 $day_exists   = array_key_exists( 'day', $date_query ) && is_numeric( $date_query['day'] );
 432                 $month_exists = array_key_exists( 'month', $date_query ) && is_numeric( $date_query['month'] );
 433                 $year_exists  = array_key_exists( 'year', $date_query ) && is_numeric( $date_query['year'] );
 434
 435                 if ( $day_exists && $month_exists && $year_exists ) {
 436                         // 1. Checking day, month, year combination.
 437                         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'] ) ) ) {
 438                                 /* translators: 1: year, 2: month, 3: day of month */
 439                                 $day_month_year_error_msg = sprintf(
 440                                         __( 'The following values do not describe a valid date: year %1$s, month %2$s, day %3$s.' ),
 441                                         '<code>' . esc_html( $date_query['year'] ) . '</code>',
 442                                         '<code>' . esc_html( $date_query['month'] ) . '</code>',
 443                                         '<code>' . esc_html( $date_query['day'] ) . '</code>'
 444                                 );
 445
 446                                 $valid = false;
 447                         }
 448
 449                 } elseif ( $day_exists && $month_exists ) {
 450                         /*
 451                          * 2. checking day, month combination
 452                          * We use 2012 because, as a leap year, it's the most permissive.
 453                          */
 454                         if ( ! wp_checkdate( $date_query['month'], $date_query['day'], 2012, sprintf( '2012-%s-%s', $date_query['month'], $date_query['day'] ) ) ) {
 455                                 /* translators: 1: month, 2: day of month */
 456                                 $day_month_year_error_msg = sprintf(
 457                                         __( 'The following values do not describe a valid date: month %1$s, day %2$s.' ),
 458                                         '<code>' . esc_html( $date_query['month'] ) . '</code>',
 459                                         '<code>' . esc_html( $date_query['day'] ) . '</code>'
 460                                 );
 461
 462                                 $valid = false;
 463                         }
 464                 }
 465
 466                 if ( ! empty( $day_month_year_error_msg ) ) {
 467                         _doing_it_wrong( __CLASS__, $day_month_year_error_msg, '4.1.0' );
 468                 }
 469
 470                 return $valid;
 471         }
 472
 473         /**
 474          * Validates a column name parameter.
 475          *
 476          * Column names without a table prefix (like 'post_date') are checked against a whitelist of
 477          * known tables, and then, if found, have a table prefix (such as 'wp_posts.') prepended.
 478          * Prefixed column names (such as 'wp_posts.post_date') bypass this whitelist check,
 479          * and are only sanitized to remove illegal characters.
 480          *
 481          * @since 3.7.0
 482          * @access public
 483          *
 484          * @param string $column The user-supplied column name.
 485          * @return string A validated column name value.
 486          */
 487         public function validate_column( $column ) {
 488                 global $wpdb;
 489
 490                 $valid_columns = array(
 491                         'post_date', 'post_date_gmt', 'post_modified',
 492                         'post_modified_gmt', 'comment_date', 'comment_date_gmt',
 493                         'user_registered', 'registered', 'last_updated',
 494                 );
 495
 496                 // Attempt to detect a table prefix.
 497                 if ( false === strpos( $column, '.' ) ) {
 498                         /**
 499                          * Filters the list of valid date query columns.
 500                          *
 501                          * @since 3.7.0
 502                          * @since 4.1.0 Added 'user_registered' to the default recognized columns.
 503                          *
 504                          * @param array $valid_columns An array of valid date query columns. Defaults
 505                          *                             are 'post_date', 'post_date_gmt', 'post_modified',
 506                          *                             'post_modified_gmt', 'comment_date', 'comment_date_gmt',
 507                          *                                 'user_registered'
 508                          */
 509                         if ( ! in_array( $column, apply_filters( 'date_query_valid_columns', $valid_columns ) ) ) {
 510                                 $column = 'post_date';
 511                         }
 512
 513                         $known_columns = array(
 514                                 $wpdb->posts => array(
 515                                         'post_date',
 516                                         'post_date_gmt',
 517                                         'post_modified',
 518                                         'post_modified_gmt',
 519                                 ),
 520                                 $wpdb->comments => array(
 521                                         'comment_date',
 522                                         'comment_date_gmt',
 523                                 ),
 524                                 $wpdb->users => array(
 525                                         'user_registered',
 526                                 ),
 527                                 $wpdb->blogs => array(
 528                                         'registered',
 529                                         'last_updated',
 530                                 ),
 531                         );
 532
 533                         // If it's a known column name, add the appropriate table prefix.
 534                         foreach ( $known_columns as $table_name => $table_columns ) {
 535                                 if ( in_array( $column, $table_columns ) ) {
 536                                         $column = $table_name . '.' . $column;
 537                                         break;
 538                                 }
 539                         }
 540
 541                 }
 542
 543                 // Remove unsafe characters.
 544                 return preg_replace( '/[^a-zA-Z0-9_$\.]/', '', $column );
 545         }
 546
 547         /**
 548          * Generate WHERE clause to be appended to a main query.
 549          *
 550          * @since 3.7.0
 551          * @access public
 552          *
 553          * @return string MySQL WHERE clause.
 554          */
 555         public function get_sql() {
 556                 $sql = $this->get_sql_clauses();
 557
 558                 $where = $sql['where'];
 559
 560                 /**
 561                  * Filters the date query WHERE clause.
 562                  *
 563                  * @since 3.7.0
 564                  *
 565                  * @param string        $where WHERE clause of the date query.
 566                  * @param WP_Date_Query $this  The WP_Date_Query instance.
 567                  */
 568                 return apply_filters( 'get_date_sql', $where, $this );
 569         }
 570
 571         /**
 572          * Generate SQL clauses to be appended to a main query.
 573          *
 574          * Called by the public WP_Date_Query::get_sql(), this method is abstracted
 575          * out to maintain parity with the other Query classes.
 576          *
 577          * @since 4.1.0
 578          * @access protected
 579          *
 580          * @return array {
 581          *     Array containing JOIN and WHERE SQL clauses to append to the main query.
 582          *
 583          *     @type string $join  SQL fragment to append to the main JOIN clause.
 584          *     @type string $where SQL fragment to append to the main WHERE clause.
 585          * }
 586          */
 587         protected function get_sql_clauses() {
 588                 $sql = $this->get_sql_for_query( $this->queries );
 589
 590                 if ( ! empty( $sql['where'] ) ) {
 591                         $sql['where'] = ' AND ' . $sql['where'];
 592                 }
 593
 594                 return $sql;
 595         }
 596
 597         /**
 598          * Generate SQL clauses for a single query array.
 599          *
 600          * If nested subqueries are found, this method recurses the tree to
 601          * produce the properly nested SQL.
 602          *
 603          * @since 4.1.0
 604          * @access protected
 605          *
 606          * @param array $query Query to parse.
 607          * @param int   $depth Optional. Number of tree levels deep we currently are.
 608          *                     Used to calculate indentation. Default 0.
 609          * @return array {
 610          *     Array containing JOIN and WHERE SQL clauses to append to a single query array.
 611          *
 612          *     @type string $join  SQL fragment to append to the main JOIN clause.
 613          *     @type string $where SQL fragment to append to the main WHERE clause.
 614          * }
 615          */
 616         protected function get_sql_for_query( $query, $depth = 0 ) {
 617                 $sql_chunks = array(
 618                         'join'  => array(),
 619                         'where' => array(),
 620                 );
 621
 622                 $sql = array(
 623                         'join'  => '',
 624                         'where' => '',
 625                 );
 626
 627                 $indent = '';
 628                 for ( $i = 0; $i < $depth; $i++ ) {
 629                         $indent .= "  ";
 630                 }
 631
 632                 foreach ( $query as $key => $clause ) {
 633                         if ( 'relation' === $key ) {
 634                                 $relation = $query['relation'];
 635                         } elseif ( is_array( $clause ) ) {
 636
 637                                 // This is a first-order clause.
 638                                 if ( $this->is_first_order_clause( $clause ) ) {
 639                                         $clause_sql = $this->get_sql_for_clause( $clause, $query );
 640
 641                                         $where_count = count( $clause_sql['where'] );
 642                                         if ( ! $where_count ) {
 643                                                 $sql_chunks['where'][] = '';
 644                                         } elseif ( 1 === $where_count ) {
 645                                                 $sql_chunks['where'][] = $clause_sql['where'][0];
 646                                         } else {
 647                                                 $sql_chunks['where'][] = '( ' . implode( ' AND ', $clause_sql['where'] ) . ' )';
 648                                         }
 649
 650                                         $sql_chunks['join'] = array_merge( $sql_chunks['join'], $clause_sql['join'] );
 651                                 // This is a subquery, so we recurse.
 652                                 } else {
 653                                         $clause_sql = $this->get_sql_for_query( $clause, $depth + 1 );
 654
 655                                         $sql_chunks['where'][] = $clause_sql['where'];
 656                                         $sql_chunks['join'][]  = $clause_sql['join'];
 657                                 }
 658                         }
 659                 }
 660
 661                 // Filter to remove empties.
 662                 $sql_chunks['join']  = array_filter( $sql_chunks['join'] );
 663                 $sql_chunks['where'] = array_filter( $sql_chunks['where'] );
 664
 665                 if ( empty( $relation ) ) {
 666                         $relation = 'AND';
 667                 }
 668
 669                 // Filter duplicate JOIN clauses and combine into a single string.
 670                 if ( ! empty( $sql_chunks['join'] ) ) {
 671                         $sql['join'] = implode( ' ', array_unique( $sql_chunks['join'] ) );
 672                 }
 673
 674                 // Generate a single WHERE clause with proper brackets and indentation.
 675                 if ( ! empty( $sql_chunks['where'] ) ) {
 676                         $sql['where'] = '( ' . "\n  " . $indent . implode( ' ' . "\n  " . $indent . $relation . ' ' . "\n  " . $indent, $sql_chunks['where'] ) . "\n" . $indent . ')';
 677                 }
 678
 679                 return $sql;
 680         }
 681
 682         /**
 683          * Turns a single date clause into pieces for a WHERE clause.
 684          *
 685          * A wrapper for get_sql_for_clause(), included here for backward
 686          * compatibility while retaining the naming convention across Query classes.
 687          *
 688          * @since  3.7.0
 689          * @access protected
 690          *
 691          * @param  array $query Date query arguments.
 692          * @return array {
 693          *     Array containing JOIN and WHERE SQL clauses to append to the main query.
 694          *
 695          *     @type string $join  SQL fragment to append to the main JOIN clause.
 696          *     @type string $where SQL fragment to append to the main WHERE clause.
 697          * }
 698          */
 699         protected function get_sql_for_subquery( $query ) {
 700                 return $this->get_sql_for_clause( $query, '' );
 701         }
 702
 703         /**
 704          * Turns a first-order date query into SQL for a WHERE clause.
 705          *
 706          * @since  4.1.0
 707          * @access protected
 708          *
 709          * @param  array $query        Date query clause.
 710          * @param  array $parent_query Parent query of the current date query.
 711          * @return array {
 712          *     Array containing JOIN and WHERE SQL clauses to append to the main query.
 713          *
 714          *     @type string $join  SQL fragment to append to the main JOIN clause.
 715          *     @type string $where SQL fragment to append to the main WHERE clause.
 716          * }
 717          */
 718         protected function get_sql_for_clause( $query, $parent_query ) {
 719                 global $wpdb;
 720
 721                 // The sub-parts of a $where part.
 722                 $where_parts = array();
 723
 724                 $column = ( ! empty( $query['column'] ) ) ? esc_sql( $query['column'] ) : $this->column;
 725
 726                 $column = $this->validate_column( $column );
 727
 728                 $compare = $this->get_compare( $query );
 729
 730                 $inclusive = ! empty( $query['inclusive'] );
 731
 732                 // Assign greater- and less-than values.
 733                 $lt = '<';
 734                 $gt = '>';
 735
 736                 if ( $inclusive ) {
 737                         $lt .= '=';
 738                         $gt .= '=';
 739                 }
 740
 741                 // Range queries.
 742                 if ( ! empty( $query['after'] ) ) {
 743                         $where_parts[] = $wpdb->prepare( "$column $gt %s", $this->build_mysql_datetime( $query['after'], ! $inclusive ) );
 744                 }
 745                 if ( ! empty( $query['before'] ) ) {
 746                         $where_parts[] = $wpdb->prepare( "$column $lt %s", $this->build_mysql_datetime( $query['before'], $inclusive ) );
 747                 }
 748                 // Specific value queries.
 749
 750                 if ( isset( $query['year'] ) && $value = $this->build_value( $compare, $query['year'] ) )
 751                         $where_parts[] = "YEAR( $column ) $compare $value";
 752
 753                 if ( isset( $query['month'] ) && $value = $this->build_value( $compare, $query['month'] ) ) {
 754                         $where_parts[] = "MONTH( $column ) $compare $value";
 755                 } elseif ( isset( $query['monthnum'] ) && $value = $this->build_value( $compare, $query['monthnum'] ) ) {
 756                         $where_parts[] = "MONTH( $column ) $compare $value";
 757                 }
 758                 if ( isset( $query['week'] ) && false !== ( $value = $this->build_value( $compare, $query['week'] ) ) ) {
 759                         $where_parts[] = _wp_mysql_week( $column ) . " $compare $value";
 760                 } elseif ( isset( $query['w'] ) && false !== ( $value = $this->build_value( $compare, $query['w'] ) ) ) {
 761                         $where_parts[] = _wp_mysql_week( $column ) . " $compare $value";
 762                 }
 763                 if ( isset( $query['dayofyear'] ) && $value = $this->build_value( $compare, $query['dayofyear'] ) )
 764                         $where_parts[] = "DAYOFYEAR( $column ) $compare $value";
 765
 766                 if ( isset( $query['day'] ) && $value = $this->build_value( $compare, $query['day'] ) )
 767                         $where_parts[] = "DAYOFMONTH( $column ) $compare $value";
 768
 769                 if ( isset( $query['dayofweek'] ) && $value = $this->build_value( $compare, $query['dayofweek'] ) )
 770                         $where_parts[] = "DAYOFWEEK( $column ) $compare $value";
 771
 772                 if ( isset( $query['dayofweek_iso'] ) && $value = $this->build_value( $compare, $query['dayofweek_iso'] ) )
 773                         $where_parts[] = "WEEKDAY( $column ) + 1 $compare $value";
 774
 775                 if ( isset( $query['hour'] ) || isset( $query['minute'] ) || isset( $query['second'] ) ) {
 776                         // Avoid notices.
 777                         foreach ( array( 'hour', 'minute', 'second' ) as $unit ) {
 778                                 if ( ! isset( $query[ $unit ] ) ) {
 779                                         $query[ $unit ] = null;
 780                                 }
 781                         }
 782
 783                         if ( $time_query = $this->build_time_query( $column, $compare, $query['hour'], $query['minute'], $query['second'] ) ) {
 784                                 $where_parts[] = $time_query;
 785                         }
 786                 }
 787
 788                 /*
 789                  * Return an array of 'join' and 'where' for compatibility
 790                  * with other query classes.
 791                  */
 792                 return array(
 793                         'where' => $where_parts,
 794                         'join'  => array(),
 795                 );
 796         }
 797
 798         /**
 799          * Builds and validates a value string based on the comparison operator.
 800          *
 801          * @since 3.7.0
 802          * @access public
 803          *
 804          * @param string $compare The compare operator to use
 805          * @param string|array $value The value
 806          * @return string|false|int The value to be used in SQL or false on error.
 807          */
 808         public function build_value( $compare, $value ) {
 809                 if ( ! isset( $value ) )
 810                         return false;
 811
 812                 switch ( $compare ) {
 813                         case 'IN':
 814                         case 'NOT IN':
 815                                 $value = (array) $value;
 816
 817                                 // Remove non-numeric values.
 818                                 $value = array_filter( $value, 'is_numeric' );
 819
 820                                 if ( empty( $value ) ) {
 821                                         return false;
 822                                 }
 823
 824                                 return '(' . implode( ',', array_map( 'intval', $value ) ) . ')';
 825
 826                         case 'BETWEEN':
 827                         case 'NOT BETWEEN':
 828                                 if ( ! is_array( $value ) || 2 != count( $value ) ) {
 829                                         $value = array( $value, $value );
 830                                 } else {
 831                                         $value = array_values( $value );
 832                                 }
 833
 834                                 // If either value is non-numeric, bail.
 835                                 foreach ( $value as $v ) {
 836                                         if ( ! is_numeric( $v ) ) {
 837                                                 return false;
 838                                         }
 839                                 }
 840
 841                                 $value = array_map( 'intval', $value );
 842
 843                                 return $value[0] . ' AND ' . $value[1];
 844
 845                         default;
 846                                 if ( ! is_numeric( $value ) ) {
 847                                         return false;
 848                                 }
 849
 850                                 return (int) $value;
 851                 }
 852         }
 853
 854         /**
 855          * Builds a MySQL format date/time based on some query parameters.
 856          *
 857          * You can pass an array of values (year, month, etc.) with missing parameter values being defaulted to
 858          * either the maximum or minimum values (controlled by the $default_to parameter). Alternatively you can
 859          * pass a string that will be run through strtotime().
 860          *
 861          * @since 3.7.0
 862          * @access public
 863          *
 864          * @param string|array $datetime       An array of parameters or a strotime() string
 865          * @param bool         $default_to_max Whether to round up incomplete dates. Supported by values
 866          *                                     of $datetime that are arrays, or string values that are a
 867          *                                     subset of MySQL date format ('Y', 'Y-m', 'Y-m-d', 'Y-m-d H:i').
 868          *                                     Default: false.
 869          * @return string|false A MySQL format date/time or false on failure
 870          */
 871         public function build_mysql_datetime( $datetime, $default_to_max = false ) {
 872                 $now = current_time( 'timestamp' );
 873
 874                 if ( ! is_array( $datetime ) ) {
 875
 876                         /*
 877                          * Try to parse some common date formats, so we can detect
 878                          * the level of precision and support the 'inclusive' parameter.
 879                          */
 880                         if ( preg_match( '/^(\d{4})$/', $datetime, $matches ) ) {
 881                                 // Y
 882                                 $datetime = array(
 883                                         'year' => intval( $matches[1] ),
 884                                 );
 885
 886                         } elseif ( preg_match( '/^(\d{4})\-(\d{2})$/', $datetime, $matches ) ) {
 887                                 // Y-m
 888                                 $datetime = array(
 889                                         'year'  => intval( $matches[1] ),
 890                                         'month' => intval( $matches[2] ),
 891                                 );
 892
 893                         } elseif ( preg_match( '/^(\d{4})\-(\d{2})\-(\d{2})$/', $datetime, $matches ) ) {
 894                                 // Y-m-d
 895                                 $datetime = array(
 896                                         'year'  => intval( $matches[1] ),
 897                                         'month' => intval( $matches[2] ),
 898                                         'day'   => intval( $matches[3] ),
 899                                 );
 900
 901                         } elseif ( preg_match( '/^(\d{4})\-(\d{2})\-(\d{2}) (\d{2}):(\d{2})$/', $datetime, $matches ) ) {
 902                                 // Y-m-d H:i
 903                                 $datetime = array(
 904                                         'year'   => intval( $matches[1] ),
 905                                         'month'  => intval( $matches[2] ),
 906                                         'day'    => intval( $matches[3] ),
 907                                         'hour'   => intval( $matches[4] ),
 908                                         'minute' => intval( $matches[5] ),
 909                                 );
 910                         }
 911
 912                         // If no match is found, we don't support default_to_max.
 913                         if ( ! is_array( $datetime ) ) {
 914                                 // @todo Timezone issues here possibly
 915                                 return gmdate( 'Y-m-d H:i:s', strtotime( $datetime, $now ) );
 916                         }
 917                 }
 918
 919                 $datetime = array_map( 'absint', $datetime );
 920
 921                 if ( ! isset( $datetime['year'] ) )
 922                         $datetime['year'] = gmdate( 'Y', $now );
 923
 924                 if ( ! isset( $datetime['month'] ) )
 925                         $datetime['month'] = ( $default_to_max ) ? 12 : 1;
 926
 927                 if ( ! isset( $datetime['day'] ) )
 928                         $datetime['day'] = ( $default_to_max ) ? (int) date( 't', mktime( 0, 0, 0, $datetime['month'], 1, $datetime['year'] ) ) : 1;
 929
 930                 if ( ! isset( $datetime['hour'] ) )
 931                         $datetime['hour'] = ( $default_to_max ) ? 23 : 0;
 932
 933                 if ( ! isset( $datetime['minute'] ) )
 934                         $datetime['minute'] = ( $default_to_max ) ? 59 : 0;
 935
 936                 if ( ! isset( $datetime['second'] ) )
 937                         $datetime['second'] = ( $default_to_max ) ? 59 : 0;
 938
 939                 return sprintf( '%04d-%02d-%02d %02d:%02d:%02d', $datetime['year'], $datetime['month'], $datetime['day'], $datetime['hour'], $datetime['minute'], $datetime['second'] );
 940         }
 941
 942         /**
 943          * Builds a query string for comparing time values (hour, minute, second).
 944          *
 945          * If just hour, minute, or second is set than a normal comparison will be done.
 946          * However if multiple values are passed, a pseudo-decimal time will be created
 947          * in order to be able to accurately compare against.
 948          *
 949          * @since 3.7.0
 950          * @access public
 951          *
 952          * @param string $column The column to query against. Needs to be pre-validated!
 953          * @param string $compare The comparison operator. Needs to be pre-validated!
 954          * @param int|null $hour Optional. An hour value (0-23).
 955          * @param int|null $minute Optional. A minute value (0-59).
 956          * @param int|null $second Optional. A second value (0-59).
 957          * @return string|false A query part or false on failure.
 958          */
 959         public function build_time_query( $column, $compare, $hour = null, $minute = null, $second = null ) {
 960                 global $wpdb;
 961
 962                 // Have to have at least one
 963                 if ( ! isset( $hour ) && ! isset( $minute ) && ! isset( $second ) )
 964                         return false;
 965
 966                 // Complex combined queries aren't supported for multi-value queries
 967                 if ( in_array( $compare, array( 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) ) {
 968                         $return = array();
 969
 970                         if ( isset( $hour ) && false !== ( $value = $this->build_value( $compare, $hour ) ) )
 971                                 $return[] = "HOUR( $column ) $compare $value";
 972
 973                         if ( isset( $minute ) && false !== ( $value = $this->build_value( $compare, $minute ) ) )
 974                                 $return[] = "MINUTE( $column ) $compare $value";
 975
 976                         if ( isset( $second ) && false !== ( $value = $this->build_value( $compare, $second ) ) )
 977                                 $return[] = "SECOND( $column ) $compare $value";
 978
 979                         return implode( ' AND ', $return );
 980                 }
 981
 982                 // Cases where just one unit is set
 983                 if ( isset( $hour ) && ! isset( $minute ) && ! isset( $second ) && false !== ( $value = $this->build_value( $compare, $hour ) ) ) {
 984                         return "HOUR( $column ) $compare $value";
 985                 } elseif ( ! isset( $hour ) && isset( $minute ) && ! isset( $second ) && false !== ( $value = $this->build_value( $compare, $minute ) ) ) {
 986                         return "MINUTE( $column ) $compare $value";
 987                 } elseif ( ! isset( $hour ) && ! isset( $minute ) && isset( $second ) && false !== ( $value = $this->build_value( $compare, $second ) ) ) {
 988                         return "SECOND( $column ) $compare $value";
 989                 }
 990
 991                 // Single units were already handled. Since hour & second isn't allowed, minute must to be set.
 992                 if ( ! isset( $minute ) )
 993                         return false;
 994
 995                 $format = $time = '';
 996
 997                 // Hour
 998                 if ( null !== $hour ) {
 999                         $format .= '%H.';
1000                         $time   .= sprintf( '%02d', $hour ) . '.';
1001                 } else {
1002                         $format .= '0.';
1003                         $time   .= '0.';
1004                 }
1005
1006                 // Minute
1007                 $format .= '%i';
1008                 $time   .= sprintf( '%02d', $minute );
1009
1010                 if ( isset( $second ) ) {
1011                         $format .= '%s';
1012                         $time   .= sprintf( '%02d', $second );
1013                 }
1014
1015                 return $wpdb->prepare( "DATE_FORMAT( $column, %s ) $compare %f", $format, $time );
1016         }
1017 }