<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[25860] trunk/src/wp-includes/date.php: Inline documentation for the `WP_Date_Query` class in wp-includes/date.php.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/25860">25860</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2013-10-21 23:16:31 +0000 (Mon, 21 Oct 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation for the `WP_Date_Query` class in wp-includes/date.php.
- Adds a complete hash notation for the `WP_Date_Query` arguments array.
- Adds missing documentation for the `date_query_valid_columns` and `get_date_sql` filter hooks.
Props aeg0125 for the incremental patches.
Fixes <a href="http://core.trac.wordpress.org/ticket/25552">#25552</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesdatephp">trunk/src/wp-includes/date.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesdatephp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/date.php (25859 => 25860)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/date.php 2013-10-21 22:28:07 UTC (rev 25859)
+++ trunk/src/wp-includes/date.php 2013-10-21 23:16:31 UTC (rev 25860)
</span><span class="lines">@@ -2,36 +2,8 @@
</span><span class="cx"> /**
</span><span class="cx"> * WP_Date_Query will generate a MySQL WHERE clause for the specified date-based parameters.
</span><span class="cx"> *
</span><del>- * Initialize the class by passing an array of arrays of parameters. Example:
</del><ins>+ * Initialize the class by passing an array of arrays of parameters.
</ins><span class="cx"> *
</span><del>- * $date_query = new WP_Date_Query( array(
- * 'column' => 'optional, column to query against, default is post_date',
- * 'compare' => 'optional, see WP_Date_Query::get_compare()',
- * 'relation' => 'optional, OR or AND, how the sub-arrays should be compared, default is AND',
- * array(
- * 'column' => 'see above',
- * 'compare' => 'see above',
- * 'after' => 'string or array, see WP_Date_Query::build_mysql_datetime()',
- * 'before' => 'string or array, see WP_Date_Query::build_mysql_datetime()',
- * 'inclusive' => 'boolean, for after/before, whether exact value should be matched or not',
- * 'year' => '4 digit int',
- * 'month' => 'int, 1-12',
- * 'week' => 'int, 0-53',
- * 'day' => 'int, 1-31',
- * 'hour' => 'int, 0-23',
- * 'minute' => 'int, 0-60',
- * 'second' => 'int, 0-60',
- * ),
- * array(
- * ...
- * ),
- * ...
- * ) );
- *
- * Then call the get_sql() method to get the MySQL WHERE string:
- *
- * $where .= $date_query->get_sql();
- *
</del><span class="cx"> * @link http://codex.wordpress.org/Function_Reference/WP_Query Codex page.
</span><span class="cx"> *
</span><span class="cx"> * @since 3.7.0
</span><span class="lines">@@ -74,10 +46,62 @@
</span><span class="cx"> public $compare = '=';
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Constructor
</del><ins>+ * Constructor.
</ins><span class="cx"> *
</span><del>- * @param array $date_query A date query parameter array, see class descriptor for further details.
- * @param array (optional) $default_column What column name to query against. Defaults to "post_date".
</del><ins>+ * @param array $date_query {
+ * One or more associative arrays of date query parameters.
+ *
+ * @type array {
+ * @type string $column Optional. The column to query against. If undefined, inherits the value of
+ * the $default_column parameter. Default 'post_date'. Accepts 'post_date',
+ * 'post_date_gmt', 'post_modified','post_modified_gmt', 'comment_date',
+ * 'comment_date_gmt'.
+ * @type string $compare Optional. The comparison operator.
+ * Default '='. Accepts '=', '!=', '>', '>=', '<', '<=', 'IN', 'NOT IN',
+ * 'BETWEEN', 'NOT BETWEEN'.
+ * @type string $relation Optional. The boolean relationship between the date queryies.
+ * Default 'OR'. Accepts 'OR', 'AND'.
+ * @type array {
+ * @type string|array $before Optional. Date to retrieve posts before. Accepts strtotime()-compatible
+ * string, or array of 'year', 'month', 'day' values. {
+ *
+ * @type string $year The four-digit year. Default empty. Accepts any four-digit year.
+ * @type string $month Optional when passing array.The month of the year.
+ * Default (string:empty)|(array:1). Accepts numbers 1-12.
+ * @type string $day Optional when passing array.The day of the month.
+ * Default (string:empty)|(array:1). Accepts numbers 1-31.
+ * }
+ * @type string|array $after Optional. Date to retrieve posts before. Accepts strtotime()-compatible
+ * string, or array of 'year', 'month', 'day' values. {
+ *
+ * @type string $year The four-digit year. Default empty. Accepts any four-digit year.
+ * @type string $month Optional when passing array.The month of the year.
+ * Default (string:empty)|(array:12). Accepts numbers 1-12.
+ * @type string $day Optional when passing array.The day of the month.
+ * Default (string:empty)|(array:last day of month). Accepts numbers 1-31.
+ * }
+ * @type string $column Optional. Used to add a clause comparing a column other than the column
+ * specified in the top-level $column paramater. Default is the value
+ * of top-level $column. Accepts 'post_date', 'post_date_gmt',
+ * 'post_modified', 'post_modified_gmt', 'comment_date', 'comment_date_gmt'.
+ * @type string $compare Optional. The comparison operator. Default '='. Accepts '=', '!=',
+ * '>', '>=', '<', '<=', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN'.
+ * @type bool $inclusive Optional. Include results from dates specified in 'before' or 'after'.
+ * Default. Accepts.
+ * @type int $year Optional. The four-digit near number. Default empty. Accepts any
+ * four-digit year.
+ * @type int $month Optional. The two-digit month number. Default empty. Accepts numbers 1-12.
+ * @type int $week Optional. The week number of the year. Default empty. Accepts numbers 0-53.
+ * @type int $day Optional. The day of the month. Default empty. Accepts numbers 1-31.
+ * @type int $hour Optional. The hour of the day. Default empty. Accepts numbers 0-23.
+ * @type int $minute Optional. The minute of the hour. Default empty. Accepts numbers 0-60.
+ * @type int $second Optional. The second of the minute. Default empty. Accepts numbers 0-60.
+ * }
+ * }
+ * }
+ * @param array $default_column Optional. Default column to query against. Default 'post_date'.
+ * Accepts 'post_date', 'post_date_gmt', 'post_modified', 'post_modified_gmt',
+ * 'comment_date', 'comment_date_gmt'.
</ins><span class="cx"> */
</span><span class="cx"> function __construct( $date_query, $default_column = 'post_date' ) {
</span><span class="cx"> if ( empty( $date_query ) || ! is_array( $date_query ) )
</span><span class="lines">@@ -136,7 +160,19 @@
</span><span class="cx"> * @return string A validated column name value.
</span><span class="cx"> */
</span><span class="cx"> public function validate_column( $column ) {
</span><del>- 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' ) ) ) )
</del><ins>+ $valid_columns = array(
+ 'post_date', 'post_date_gmt', 'post_modified',
+ 'post_modified_gmt', 'comment_date', 'comment_date_gmt'
+ );
+ /**
+ * Filter the list of valid date query columns.
+ *
+ * @since 3.7.0
+ *
+ * @param array $valid_columns An array of valid date query columns. Defaults are 'post_date', 'post_date_gmt',
+ * 'post_modified', 'post_modified_gmt', 'comment_date', 'comment_date_gmt'
+ */
+ if ( ! in_array( $column, apply_filters( 'date_query_valid_columns', $valid_columns ) ) )
</ins><span class="cx"> $column = 'post_date';
</span><span class="cx">
</span><span class="cx"> return $column;
</span><span class="lines">@@ -168,6 +204,14 @@
</span><span class="cx"> else
</span><span class="cx"> $where = '';
</span><span class="cx">
</span><ins>+ /**
+ * Filter the date query WHERE clause.
+ *
+ * @since 3.7.0
+ *
+ * @param string $where WHERE clause of the date query.
+ * @param WP_Date_Query $this The WP_Date_Query instance.
+ */
</ins><span class="cx"> return apply_filters( 'get_date_sql', $where, $this );
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>