<!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>[34548] trunk/src/wp-includes/class-wp-comment-query.php: Normalize whitespace in `WP_Comment_Query` documentation.</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" 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/34548">34548</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/34548","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-09-25 15:24:15 +0000 (Fri, 25 Sep 2015)</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'>Normalize whitespace in `WP_Comment_Query` documentation.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpcommentqueryphp">trunk/src/wp-includes/class-wp-comment-query.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpcommentqueryphp"></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-comment-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-comment-query.php 2015-09-25 15:18:58 UTC (rev 34547)
+++ trunk/src/wp-includes/class-wp-comment-query.php 2015-09-25 15:24:15 UTC (rev 34548)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -144,76 +144,98 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $query {
</span><span class="cx" style="display: block; padding: 0 10px"> * Optional. Array or query string of comment query parameters. Default empty.
</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 $author_email Comment author email address. Default empty.
- * @type array $author__in Array of author IDs to include comments for. Default empty.
- * @type array $author__not_in Array of author IDs to exclude comments for. Default empty.
- * @type array $comment__in Array of comment IDs to include. Default empty.
- * @type array $comment__not_in Array of comment IDs to exclude. Default empty.
- * @type bool $count Whether to return a comment count (true) or array of comment
- * objects (false). Default false.
- * @type array $date_query Date query clauses to limit comments by. See WP_Date_Query.
- * Default null.
- * @type string $fields Comment fields to return. Accepts 'ids' for comment IDs only or
- * empty for all fields. Default empty.
- * @type int $ID Currently unused.
- * @type array $include_unapproved Array of IDs or email addresses of users whose unapproved comments
- * will be returned by the query regardless of `$status`. Default empty.
- * @type int $karma Karma score to retrieve matching comments for. Default empty.
- * @type string $meta_key Include comments with a matching comment meta key. Default empty.
- * @type string $meta_value Include comments with a matching comment meta value. Requires
- * `$meta_key` to be set. Default empty.
- * @type array $meta_query Meta query clauses to limit retrieved comments by.
- * See WP_Meta_Query. Default empty.
- * @type int $number Maximum number of comments to retrieve. Default null (no limit).
- * @type int $offset Number of comments to offset the query. Used to build LIMIT clause.
- * Default 0.
- * @type bool $no_found_rows Whether to disable the `SQL_CALC_FOUND_ROWS` query.
- * Default: true.
- * @type string|array $orderby Comment status or array of statuses. To use 'meta_value' or
- * 'meta_value_num', `$meta_key` must also be defined. To sort by
- * a specific `$meta_query` clause, use that clause's array key.
- * Accepts 'comment_agent', 'comment_approved', 'comment_author',
- * 'comment_author_email', 'comment_author_IP',
- * 'comment_author_url', 'comment_content', 'comment_date',
- * 'comment_date_gmt', 'comment_ID', 'comment_karma',
- * 'comment_parent', 'comment_post_ID', 'comment_type', 'user_id',
- * 'comment__in', 'meta_value', 'meta_value_num', the value of $meta_key, and the
- * array keys of `$meta_query`. Also accepts false, an empty array,
- * or 'none' to disable `ORDER BY` clause.
- * Default: 'comment_date_gmt'.
- * @type string $order How to order retrieved comments. Accepts 'ASC', 'DESC'.
- * Default: 'DESC'.
- * @type int $parent Parent ID of comment to retrieve children of. Default empty.
- * @type array $parent__in Array of parent IDs of comments to retrieve children for. Default empty.
- * @type array $parent__not_in Array of parent IDs of comments *not* to retrieve children for. Default empty.
- * @type array $post_author__in Array of author IDs to retrieve comments for. Default empty.
- * @type array $post_author__not_in Array of author IDs *not* to retrieve comments for. Default empty.
- * @type int $post_ID Currently unused.
- * @type int $post_id Limit results to those affiliated with a given post ID. Default 0.
- * @type array $post__in Array of post IDs to include affiliated comments for. Default empty.
- * @type array $post__not_in Array of post IDs to exclude affiliated comments for. Default empty.
- * @type int $post_author Comment author ID to limit results by. Default empty.
- * @type string $post_status Post status to retrieve affiliated comments for. Default empty.
- * @type string $post_type Post type to retrieve affiliated comments for. Default empty.
- * @type string $post_name Post name to retrieve affiliated comments for. Default empty.
- * @type int $post_parent Post parent ID to retrieve affiliated comments for. Default empty.
- * @type string $search Search term(s) to retrieve matching comments for. Default empty.
- * @type string $status Comment status to limit results by. Accepts 'hold'
- * (`comment_status=0`), 'approve' (`comment_status=1`), 'all', or a
- * custom comment status. Default 'all'.
- * @type string|array $type Include comments of a given type, or array of types. Accepts
- * 'comment', 'pings' (includes 'pingback' and 'trackback'), or any
- * custom type string. Default empty.
- * @type array $type__in Include comments from a given array of comment types. Default empty.
- * @type array $type__not_in Exclude comments from a given array of comment types. Default empty.
- * @type int $user_id Include comments for a specific user ID. Default empty.
- * @type bool|string $hierarchical Whether to include comment descendants in the results.
- * 'threaded' returns a tree, with each comment's children stored
- * in a `children` property on the `WP_Comment` object. 'flat'
- * returns a flat array of found comments plus their children.
- * Pass `false` to leave out descendants. The parameter is ignored
- * (forced to `false`) when `$fields` is 'ids' or 'counts'.
- * Accepts 'threaded', 'flat', or false. Default: false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $author_email Comment author email address. Default empty.
+ * @type array $author__in Array of author IDs to include comments for. Default empty.
+ * @type array $author__not_in Array of author IDs to exclude comments for. Default empty.
+ * @type array $comment__in Array of comment IDs to include. Default empty.
+ * @type array $comment__not_in Array of comment IDs to exclude. Default empty.
+ * @type bool $count Whether to return a comment count (true) or array of
+ * comment objects (false). Default false.
+ * @type array $date_query Date query clauses to limit comments by. See WP_Date_Query.
+ * Default null.
+ * @type string $fields Comment fields to return. Accepts 'ids' for comment IDs
+ * only or empty for all fields. Default empty.
+ * @type int $ID Currently unused.
+ * @type array $include_unapproved Array of IDs or email addresses of users whose unapproved
+ * comments will be returned by the query regardless of
+ * `$status`. Default empty.
+ * @type int $karma Karma score to retrieve matching comments for.
+ * Default empty.
+ * @type string $meta_key Include comments with a matching comment meta key.
+ * Default empty.
+ * @type string $meta_value Include comments with a matching comment meta value.
+ * Requires `$meta_key` to be set. Default empty.
+ * @type array $meta_query Meta query clauses to limit retrieved comments by.
+ * See WP_Meta_Query. Default empty.
+ * @type int $number Maximum number of comments to retrieve.
+ * Default null (no limit).
+ * @type int $offset Number of comments to offset the query. Used to build
+ * LIMIT clause. Default 0.
+ * @type bool $no_found_rows Whether to disable the `SQL_CALC_FOUND_ROWS` query.
+ * Default: true.
+ * @type string|array $orderby Comment status or array of statuses. To use 'meta_value'
+ * or 'meta_value_num', `$meta_key` must also be defined.
+ * To sort by a specific `$meta_query` clause, use that
+ * clause's array key. Accepts 'comment_agent',
+ * 'comment_approved', 'comment_author',
+ * 'comment_author_email', 'comment_author_IP',
+ * 'comment_author_url', 'comment_content', 'comment_date',
+ * 'comment_date_gmt', 'comment_ID', 'comment_karma',
+ * 'comment_parent', 'comment_post_ID', 'comment_type',
+ * 'user_id', 'comment__in', 'meta_value', 'meta_value_num',
+ * the value of $meta_key, and the array keys of
+ * `$meta_query`. Also accepts false, an empty array, or
+ * 'none' to disable `ORDER BY` clause.
+ * Default: 'comment_date_gmt'.
+ * @type string $order How to order retrieved comments. Accepts 'ASC', 'DESC'.
+ * Default: 'DESC'.
+ * @type int $parent Parent ID of comment to retrieve children of.
+ * Default empty.
+ * @type array $parent__in Array of parent IDs of comments to retrieve children for.
+ * Default empty.
+ * @type array $parent__not_in Array of parent IDs of comments *not* to retrieve
+ * children for. Default empty.
+ * @type array $post_author__in Array of author IDs to retrieve comments for.
+ * Default empty.
+ * @type array $post_author__not_in Array of author IDs *not* to retrieve comments for.
+ * Default empty.
+ * @type int $post_ID Currently unused.
+ * @type int $post_id Limit results to those affiliated with a given post ID.
+ * Default 0.
+ * @type array $post__in Array of post IDs to include affiliated comments for.
+ * Default empty.
+ * @type array $post__not_in Array of post IDs to exclude affiliated comments for.
+ * Default empty.
+ * @type int $post_author Comment author ID to limit results by. Default empty.
+ * @type string $post_status Post status to retrieve affiliated comments for.
+ * Default empty.
+ * @type string $post_type Post type to retrieve affiliated comments for.
+ * Default empty.
+ * @type string $post_name Post name to retrieve affiliated comments for.
+ * Default empty.
+ * @type int $post_parent Post parent ID to retrieve affiliated comments for.
+ * Default empty.
+ * @type string $search Search term(s) to retrieve matching comments for.
+ * Default empty.
+ * @type string $status Comment status to limit results by. Accepts 'hold'
+ * (`comment_status=0`), 'approve' (`comment_status=1`),
+ * 'all', or a custom comment status. Default 'all'.
+ * @type string|array $type Include comments of a given type, or array of types.
+ * Accepts 'comment', 'pings' (includes 'pingback' and
+ * 'trackback'), or anycustom type string. Default empty.
+ * @type array $type__in Include comments from a given array of comment types.
+ * Default empty.
+ * @type array $type__not_in Exclude comments from a given array of comment types.
+ * Default empty.
+ * @type int $user_id Include comments for a specific user ID. Default empty.
+ * @type bool|string $hierarchical Whether to include comment descendants in the results.
+ * 'threaded' returns a tree, with each comment's children
+ * stored in a `children` property on the `WP_Comment`
+ * object. 'flat' returns a flat array of found comments plus
+ * their children. Pass `false` to leave out descendants.
+ * The parameter is ignored (forced to `false`) when
+ * `$fields` is 'ids' or 'counts'. Accepts 'threaded',
+ * 'flat', or false. Default: false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type bool $update_comment_meta_cache Whether to prime the metadata cache for found comments.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default true.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span></span></pre>
</div>
</div>
</body>
</html>