<!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>[51906] trunk/src/wp-includes/class-wp-date-query.php: Docs: Update `WP_Date_Query` documentation to reflect changes in accepted column names.</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 { white-space: pre-line; 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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/51906">51906</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/51906","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-10-14 18:03:07 +0000 (Thu, 14 Oct 2021)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Update `WP_Date_Query` documentation to reflect changes in accepted column names.
Remove outdated list of accepted column name values, add a reference to `WP_Date_Query::validate_column()` and the `date_query_valid_columns` filter instead for a more detailed description.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/25139">[25139]</a>, <a href="https://core.trac.wordpress.org/changeset/25860">[25860]</a>, <a href="https://core.trac.wordpress.org/changeset/29933">[29933]</a>, <a href="https://core.trac.wordpress.org/changeset/29934">[29934]</a>, <a href="https://core.trac.wordpress.org/changeset/29938">[29938]</a>, <a href="https://core.trac.wordpress.org/changeset/37477">[37477]</a>, <a href="https://core.trac.wordpress.org/changeset/51905">[51905]</a>.
Props dimadin, johnjamesjacoby.
Fixes <a href="https://core.trac.wordpress.org/ticket/54248">#54248</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpdatequeryphp">trunk/src/wp-includes/class-wp-date-query.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpdatequeryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-date-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-date-query.php 2021-10-13 19:58:35 UTC (rev 51905)
+++ trunk/src/wp-includes/class-wp-date-query.php 2021-10-14 18:03:07 UTC (rev 51906)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -74,8 +74,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array ...$0 {
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $column Optional. The column to query against. If undefined, inherits the value of
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * the `$default_column` parameter. Accepts 'post_date', 'post_date_gmt',
- * 'post_modified','post_modified_gmt', 'comment_date', 'comment_date_gmt'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * the `$default_column` parameter. See WP_Date_Query::validate_column() and
+ * the {@see 'date_query_valid_columns'} filter for the list of accepted values.
</ins><span class="cx" style="display: block; padding: 0 10px"> * Default 'post_date'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $compare Optional. The comparison operator. Accepts '=', '!=', '>', '>=', '<', '<=',
</span><span class="cx" style="display: block; padding: 0 10px"> * 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN'. Default '='.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -104,11 +104,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $day Optional when passing array.The day of the month. Accepts numbers 1-31.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default (string:empty)|(array:last day of month).
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $column Optional. Used to add a clause comparing a column other than the
- * column specified in the top-level `$column` parameter. Accepts
- * 'post_date', 'post_date_gmt', 'post_modified', 'post_modified_gmt',
- * 'comment_date', 'comment_date_gmt'. Default is the value of
- * top-level `$column`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $column Optional. Used to add a clause comparing a column other than
+ * the column specified in the top-level `$column` parameter.
+ * See WP_Date_Query::validate_column() and
+ * the {@see 'date_query_valid_columns'} filter for the list
+ * of accepted values. Default is the value of top-level `$column`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type string $compare Optional. The comparison operator. Accepts '=', '!=', '>', '>=',
</span><span class="cx" style="display: block; padding: 0 10px"> * '<', '<=', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN'. 'IN',
</span><span class="cx" style="display: block; padding: 0 10px"> * 'NOT IN', 'BETWEEN', and 'NOT BETWEEN'. Comparisons support
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -140,9 +140,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $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'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $default_column Optional. Default column to query against. See WP_Date_Query::validate_column()
+ * and the {@see 'date_query_valid_columns'} filter for the list of accepted values.
+ * Default 'post_date'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function __construct( $date_query, $default_column = 'post_date' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $date_query ) || ! is_array( $date_query ) ) {
</span></span></pre>
</div>
</div>
</body>
</html>