| | 3614 | * WP_Date_Query will generate a MySQL WHERE clause for the specified date-based parameters. |
| | 3615 | * |
| | 3616 | * Initialize the class by passing an array of arrays of parameters. Example: |
| | 3617 | * |
| | 3618 | * $date_query = new WP_Date_Query( array( |
| | 3619 | * 'column' => 'optional, column to query against, default is post_date', |
| | 3620 | * 'compare' => 'optional, see WP_Date_Query::get_compare()', |
| | 3621 | * 'relation' => 'optional, OR or AND, how the sub-arrays should be compared, default is AND', |
| | 3622 | * array( |
| | 3623 | * 'column' => 'see above', |
| | 3624 | * 'compare' => 'see above', |
| | 3625 | * 'after' => 'string or array, see WP_Date_Query::build_mysql_datetime()', |
| | 3626 | * 'before' => 'string or array, see WP_Date_Query::build_mysql_datetime()', |
| | 3627 | * 'inclusive' => 'boolean, for after/before, whether exact value should be matched or not', |
| | 3628 | * 'year' => '4 digit int', |
| | 3629 | * 'month' => 'int, 1-12', |
| | 3630 | * 'week' => 'int, 0-53', |
| | 3631 | * 'day' => 'int, 1-31', |
| | 3632 | * 'hour' => 'int, 0-23', |
| | 3633 | * 'minute' => 'int, 0-60', |
| | 3634 | * 'second' => 'int, 0-60', |
| | 3635 | * ), |
| | 3636 | * array( |
| | 3637 | * ... |
| | 3638 | * ), |
| | 3639 | * ... |
| | 3640 | * ) ); |
| | 3641 | * |
| | 3642 | * Then call the get_sql() method to get the MySQL WHERE string: |
| | 3643 | * |
| | 3644 | * $where .= $date_query->get_sql(); |
| | 3645 | * |
| | 3646 | * @link http://codex.wordpress.org/Function_Reference/WP_Query Codex page. |
| | 3647 | * |
| | 3648 | * @since 3.7.0 |
| | 3649 | */ |
| | 3650 | class WP_Date_Query { |
| | 3651 | /** |
| | 3652 | * List of date queries. |
| | 3653 | * |
| | 3654 | * @since 3.7.0 |
| | 3655 | * @access public |
| | 3656 | * @var array |
| | 3657 | */ |
| | 3658 | public $queries = array(); |
| | 3659 | |
| | 3660 | /** |
| | 3661 | * The relation between the queries. Can be either 'AND' or 'OR' and can be changed via the query arguments. |
| | 3662 | * |
| | 3663 | * @since 3.7.0 |
| | 3664 | * @access public |
| | 3665 | * @var string |
| | 3666 | */ |
| | 3667 | public $relation = 'AND'; |
| | 3668 | |
| | 3669 | /** |
| | 3670 | * The column to query against. Can be changed via the query arguments. |
| | 3671 | * |
| | 3672 | * @since 3.7.0 |
| | 3673 | * @access public |
| | 3674 | * @var string |
| | 3675 | */ |
| | 3676 | public $column = 'post_date'; |
| | 3677 | |
| | 3678 | /** |
| | 3679 | * The value comparison operator. Can be changed via the query arguments. |
| | 3680 | * |
| | 3681 | * @since 3.7.0 |
| | 3682 | * @access public |
| | 3683 | * @var array |
| | 3684 | */ |
| | 3685 | public $compare = '='; |
| | 3686 | |
| | 3687 | /** |
| | 3688 | * Constructor |
| | 3689 | * |
| | 3690 | * @param array $date_query A date query parameter array, see class descriptor for further details. |
| | 3691 | * @param array (optional) $default_column What column name to query against. Defaults to "post_date". |
| | 3692 | */ |
| | 3693 | function __construct( $date_query, $default_column = 'post_date' ) { |
| | 3694 | if ( empty( $date_query ) || ! is_array( $date_query ) ) |
| | 3695 | return; |
| | 3696 | |
| | 3697 | if ( isset( $date_query['relation'] ) && strtoupper( $date_query['relation'] ) == 'OR' ) { |
| | 3698 | $this->relation = 'OR'; |
| | 3699 | } else { |
| | 3700 | $this->relation = 'AND'; |
| | 3701 | } |
| | 3702 | |
| | 3703 | if ( ! empty( $date_query['column'] ) ) |
| | 3704 | $this->column = esc_sql( $date_query['column'] ); |
| | 3705 | else |
| | 3706 | $this->column = esc_sql( $default_column ); |
| | 3707 | |
| | 3708 | $this->column = $this->validate_column( $this->column ); |
| | 3709 | |
| | 3710 | $this->compare = $this->get_compare( $date_query ); |
| | 3711 | |
| | 3712 | // If an array of arrays wasn't passed, fix it |
| | 3713 | if ( ! isset( $date_query[0] ) ) |
| | 3714 | $date_query = array( $date_query ); |
| | 3715 | |
| | 3716 | $this->queries = array(); |
| | 3717 | foreach ( $date_query as $key => $query ) { |
| | 3718 | if ( ! is_array( $query ) ) |
| | 3719 | continue; |
| | 3720 | |
| | 3721 | $this->queries[$key] = $query; |
| | 3722 | } |
| | 3723 | } |
| | 3724 | |
| | 3725 | /** |
| | 3726 | * Determines and validates what comparison operator to use. |
| | 3727 | * |
| | 3728 | * @since 3.7.0 |
| | 3729 | * @access public |
| | 3730 | * |
| | 3731 | * @param array $query A date query or a date subquery |
| | 3732 | * @return string The comparison operator |
| | 3733 | */ |
| | 3734 | public function get_compare( $query ) { |
| | 3735 | if ( ! empty( $query['compare'] ) && in_array( $query['compare'], array( '=', '!=', '>', '>=', '<', '<=', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) ) |
| | 3736 | return strtoupper( $query['compare'] ); |
| | 3737 | |
| | 3738 | return $this->compare; |
| | 3739 | } |
| | 3740 | |
| | 3741 | /** |
| | 3742 | * Validates a column name parameter. |
| | 3743 | * |
| | 3744 | * @since 3.7.0 |
| | 3745 | * @access public |
| | 3746 | * |
| | 3747 | * @param string $column The user-supplied column name. |
| | 3748 | * @return string A validated column name value. |
| | 3749 | */ |
| | 3750 | public function validate_column( $column ) { |
| | 3751 | 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' ) ) ) ) |
| | 3752 | $column = 'post_date'; |
| | 3753 | |
| | 3754 | return $column; |
| | 3755 | } |
| | 3756 | |
| | 3757 | /** |
| | 3758 | * Turns an array of date query parameters into a MySQL string. |
| | 3759 | * |
| | 3760 | * @since 3.7.0 |
| | 3761 | * @access public |
| | 3762 | * |
| | 3763 | * @return string MySQL WHERE parameters |
| | 3764 | */ |
| | 3765 | public function get_sql() { |
| | 3766 | global $wpdb; |
| | 3767 | |
| | 3768 | // The parts of the final query |
| | 3769 | $where = array(); |
| | 3770 | |
| | 3771 | foreach ( $this->queries as $key => $query ) { |
| | 3772 | |
| | 3773 | // The sub-parts of a $where part |
| | 3774 | $where_parts = array(); |
| | 3775 | |
| | 3776 | $column = ( ! empty( $query['column'] ) ) ? esc_sql( $query['column'] ) : $this->column; |
| | 3777 | |
| | 3778 | $column = $this->validate_column( $column ); |
| | 3779 | |
| | 3780 | $compare = $this->get_compare( $query ); |
| | 3781 | |
| | 3782 | $lt = '<'; |
| | 3783 | $gt = '>'; |
| | 3784 | if ( ! empty( $query['inclusive'] ) ) { |
| | 3785 | $lt .= '='; |
| | 3786 | $gt .= '='; |
| | 3787 | } |
| | 3788 | |
| | 3789 | // Range queries |
| | 3790 | if ( ! empty( $query['after'] ) ) |
| | 3791 | $where_parts[] = $wpdb->prepare( "$column $gt %s", $this->build_mysql_datetime( $query['after'], true ) ); |
| | 3792 | |
| | 3793 | if ( ! empty( $query['before'] ) ) |
| | 3794 | $where_parts[] = $wpdb->prepare( "$column $lt %s", $this->build_mysql_datetime( $query['before'], false ) ); |
| | 3795 | |
| | 3796 | // Specific value queries |
| | 3797 | |
| | 3798 | if ( isset( $query['year'] ) && $value = $this->build_value( $compare, $query['year'] ) ) |
| | 3799 | $where_parts[] = "YEAR( $column ) $compare $value"; |
| | 3800 | |
| | 3801 | if ( isset( $query['month'] ) && $value = $this->build_value( $compare, $query['month'] ) ) |
| | 3802 | $where_parts[] = "MONTH( $column ) $compare $value"; |
| | 3803 | |
| | 3804 | // Legacy |
| | 3805 | if ( isset( $query['monthnum'] ) && $value = $this->build_value( $compare, $query['monthnum'] ) ) |
| | 3806 | $where_parts[] = "MONTH( $column ) $compare $value"; |
| | 3807 | |
| | 3808 | if ( isset( $query['week'] ) && false !== ( $value = $this->build_value( $compare, $query['week'] ) ) ) |
| | 3809 | $where_parts[] = _wp_mysql_week( $column ) . " $compare $value"; |
| | 3810 | |
| | 3811 | // Legacy |
| | 3812 | if ( isset( $query['w'] ) && false !== ( $value = $this->build_value( $compare, $query['w'] ) ) ) |
| | 3813 | $where_parts[] = _wp_mysql_week( $column ) . " $compare $value"; |
| | 3814 | |
| | 3815 | if ( isset( $query['dayofyear'] ) && $value = $this->build_value( $compare, $query['dayofyear'] ) ) |
| | 3816 | $where_parts[] = "DAYOFYEAR( $column ) $compare $value"; |
| | 3817 | |
| | 3818 | if ( isset( $query['day'] ) && $value = $this->build_value( $compare, $query['day'] ) ) |
| | 3819 | $where_parts[] = "DAYOFMONTH( $column ) $compare $value"; |
| | 3820 | |
| | 3821 | if ( isset( $query['dayofweek'] ) && $value = $this->build_value( $compare, $query['dayofweek'] ) ) |
| | 3822 | $where_parts[] = "DAYOFWEEK( $column ) $compare $value"; |
| | 3823 | |
| | 3824 | if ( isset( $query['hour'] ) || isset( $query['minute'] ) || isset( $query['second'] ) ) { |
| | 3825 | // Avoid notices |
| | 3826 | foreach ( array( 'hour', 'minute', 'second' ) as $unit ) { |
| | 3827 | if ( ! isset( $query[$unit] ) ) { |
| | 3828 | $query[$unit] = null; |
| | 3829 | } |
| | 3830 | } |
| | 3831 | |
| | 3832 | if ( $time_query = $this->build_time_query( $column, $compare, $query['hour'], $query['minute'], $query['second'] ) ) { |
| | 3833 | $where_parts[] = $time_query; |
| | 3834 | } |
| | 3835 | } |
| | 3836 | |
| | 3837 | // Combine the parts of this subquery into a single string |
| | 3838 | if ( ! empty( $where_parts ) ) |
| | 3839 | $where[$key] = '( ' . implode( ' AND ', $where_parts ) . ' )'; |
| | 3840 | } |
| | 3841 | |
| | 3842 | // Combine the subquery strings into a single string |
| | 3843 | if ( ! empty( $where ) ) |
| | 3844 | $where = ' AND ( ' . implode( " {$this->relation} ", $where ) . ' )'; |
| | 3845 | else |
| | 3846 | $where = ''; |
| | 3847 | |
| | 3848 | return apply_filters( 'get_date_sql', $where, $this ); |
| | 3849 | } |
| | 3850 | |
| | 3851 | /** |
| | 3852 | * Builds and validates a value string based on the comparison operator. |
| | 3853 | * |
| | 3854 | * @since 3.7.0 |
| | 3855 | * @access public |
| | 3856 | * |
| | 3857 | * @param string $compare The compare operator to use |
| | 3858 | * @param string|array $value The value |
| | 3859 | * @return string|int|false The value to be used in SQL or false on error. |
| | 3860 | */ |
| | 3861 | public function build_value( $compare, $value ) { |
| | 3862 | if ( ! isset( $value ) ) |
| | 3863 | return false; |
| | 3864 | |
| | 3865 | switch ( $compare ) { |
| | 3866 | case 'IN': |
| | 3867 | case 'NOT IN': |
| | 3868 | return '(' . implode( ',', array_map( 'intval', (array) $value ) ) . ')'; |
| | 3869 | |
| | 3870 | case 'BETWEEN': |
| | 3871 | case 'NOT BETWEEN': |
| | 3872 | if ( ! is_array( $value ) || 2 != count( $value ) || ! isset( $value[0] ) || ! isset( $value[1] ) ) |
| | 3873 | $value = array( $value, $value ); |
| | 3874 | |
| | 3875 | $value = array_map( 'intval', $value ); |
| | 3876 | |
| | 3877 | return $value[0] . ' AND ' . $value[1]; |
| | 3878 | |
| | 3879 | default; |
| | 3880 | return (int) $value; |
| | 3881 | } |
| | 3882 | } |
| | 3883 | |
| | 3884 | /** |
| | 3885 | * Builds a MySQL format date/time based on some query parameters. |
| | 3886 | * |
| | 3887 | * You can pass an array of values (year, month, etc.) with missing parameter values being defaulted to |
| | 3888 | * either the maximum or minimum values (controlled by the $default_to parameter). Alternatively you can |
| | 3889 | * pass a string that that will be run through strtotime(). |
| | 3890 | * |
| | 3891 | * @since 3.7.0 |
| | 3892 | * @access public |
| | 3893 | * |
| | 3894 | * @param string|array $datetime An array of parameters or a strotime() string |
| | 3895 | * @param string $default_to Controls what values default to if they are missing from $datetime. Pass "min" or "max". |
| | 3896 | * @return string|false A MySQL format date/time or false on failure |
| | 3897 | */ |
| | 3898 | public function build_mysql_datetime( $datetime, $default_to_max = false ) { |
| | 3899 | $now = current_time( 'timestamp' ); |
| | 3900 | |
| | 3901 | if ( is_array( $datetime ) ) { |
| | 3902 | $datetime = array_map( 'absint', $datetime ); |
| | 3903 | |
| | 3904 | if ( ! isset( $datetime['year'] ) ) |
| | 3905 | $datetime['year'] = gmdate( 'Y', $now ); |
| | 3906 | |
| | 3907 | if ( ! isset( $datetime['month'] ) ) |
| | 3908 | $datetime['month'] = ( $default_to_max ) ? 12 : 1; |
| | 3909 | |
| | 3910 | if ( ! isset( $datetime['day'] ) ) |
| | 3911 | $datetime['day'] = ( $default_to_max ) ? (int) date( 't', mktime( 0, 0, 0, $datetime['month'], 1, $datetime['year'] ) ) : 1; |
| | 3912 | |
| | 3913 | if ( ! isset( $datetime['hour'] ) ) |
| | 3914 | $datetime['hour'] = ( $default_to_max ) ? 23 : 0; |
| | 3915 | |
| | 3916 | if ( ! isset( $datetime['minute'] ) ) |
| | 3917 | $datetime['minute'] = ( $default_to_max ) ? 59 : 0; |
| | 3918 | |
| | 3919 | if ( ! isset( $datetime['second'] ) ) |
| | 3920 | $datetime['second'] = ( $default_to_max ) ? 59 : 0; |
| | 3921 | |
| | 3922 | return sprintf( '%04d-%02d-%02d %02d:%02d:%02d', $datetime['year'], $datetime['month'], $datetime['day'], $datetime['hour'], $datetime['minute'], $datetime['second'] ); |
| | 3923 | } else { |
| | 3924 | // Timezone issues here possibly |
| | 3925 | return gmdate( 'Y-m-d H:i:s', strtotime( $datetime, $now ) ); |
| | 3926 | } |
| | 3927 | |
| | 3928 | return false; |
| | 3929 | } |
| | 3930 | |
| | 3931 | /** |
| | 3932 | * Builds a query string for comparing time values (hour, minute, second). |
| | 3933 | * |
| | 3934 | * If just hour, minute, or second is set than a normal comparison will be done. |
| | 3935 | * However if multiple values are passed, a pseudo-decimal time will be created |
| | 3936 | * in order to be able to accurately compare against. |
| | 3937 | * |
| | 3938 | * @since 3.7.0 |
| | 3939 | * @access public |
| | 3940 | * |
| | 3941 | * @param string $column The column to query against. Needs to be pre-validated! |
| | 3942 | * @param string $compare The comparison operator. Needs to be pre-validated! |
| | 3943 | * @param int|null $hour Optional. An hour value (0-23). |
| | 3944 | * @param int|null $minute Optional. A minute value (0-59). |
| | 3945 | * @param int|null $second Optional. A second value (0-59). |
| | 3946 | * @return string|false A query part or false on failure. |
| | 3947 | */ |
| | 3948 | public function build_time_query( $column, $compare, $hour = null, $minute = null, $second = null ) { |
| | 3949 | global $wpdb; |
| | 3950 | |
| | 3951 | // Have to have at least one |
| | 3952 | if ( ! isset( $hour ) && ! isset( $minute ) && ! isset( $second ) ) |
| | 3953 | return false; |
| | 3954 | |
| | 3955 | // Complex combined queries aren't supported for multi-value queries |
| | 3956 | if ( in_array( $compare, array( 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) ) { |
| | 3957 | $return = array(); |
| | 3958 | |
| | 3959 | if ( isset( $hour ) && false !== ( $value = $this->build_value( $compare, $hour ) ) ) |
| | 3960 | $return[] = "HOUR( $column ) $compare $value"; |
| | 3961 | |
| | 3962 | if ( isset( $minute ) && false !== ( $value = $this->build_value( $compare, $minute ) ) ) |
| | 3963 | $return[] = "MINUTE( $column ) $compare $value"; |
| | 3964 | |
| | 3965 | if ( isset( $second ) && false !== ( $value = $this->build_value( $compare, $second ) ) ) |
| | 3966 | $return[] = "SECOND( $column ) $compare $value"; |
| | 3967 | |
| | 3968 | return implode( ' AND ', $return ); |
| | 3969 | } |
| | 3970 | |
| | 3971 | // Cases where just one unit is set |
| | 3972 | if ( isset( $hour ) && ! isset( $minute ) && ! isset( $second ) && false !== ( $value = $this->build_value( $compare, $hour ) ) ) { |
| | 3973 | return "HOUR( $column ) $compare $value"; |
| | 3974 | } elseif ( ! isset( $hour ) && isset( $minute ) && ! isset( $second ) && false !== ( $value = $this->build_value( $compare, $minute ) ) ) { |
| | 3975 | return "MINUTE( $column ) $compare $value"; |
| | 3976 | } elseif ( ! isset( $hour ) && ! isset( $minute ) && isset( $second ) && false !== ( $value = $this->build_value( $compare, $second ) ) ) { |
| | 3977 | return "SECOND( $column ) $compare $value"; |
| | 3978 | } |
| | 3979 | |
| | 3980 | // Single units were already handled. Since hour & second isn't allowed, minute must to be set. |
| | 3981 | if ( ! isset( $minute ) ) |
| | 3982 | return false; |
| | 3983 | |
| | 3984 | $format = $time = ''; |
| | 3985 | |
| | 3986 | // Hour |
| | 3987 | if ( $hour ) { |
| | 3988 | $format .= '%H.'; |
| | 3989 | $time .= sprintf( '%02d', $hour ) . '.'; |
| | 3990 | } else { |
| | 3991 | $format .= '0.'; |
| | 3992 | $time .= '0.'; |
| | 3993 | } |
| | 3994 | |
| | 3995 | // Minute |
| | 3996 | $format .= '%i'; |
| | 3997 | $time .= sprintf( '%02d', $minute ); |
| | 3998 | |
| | 3999 | if ( isset( $second ) ) { |
| | 4000 | $format .= '%s'; |
| | 4001 | $time .= sprintf( '%02d', $second ); |
| | 4002 | } |
| | 4003 | |
| | 4004 | return $wpdb->prepare( "DATE_FORMAT( $column, %s ) $compare %f", $format, $time ); |
| | 4005 | } |
| | 4006 | } |
| | 4007 | |
| | 4008 | /** |