<!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>[34569] trunk: Comments: in `WP_Comment::get_children()`, accept an array so that the values for `format`, `status`, `hierarchical`, and `orderby` can be passed, instead of just `format`.</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/34569">34569</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/34569","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>wonderboymusic</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-09-26 02:24:17 +0000 (Sat, 26 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'>Comments: in `WP_Comment::get_children()`, accept an array so that the values for `format`, `status`, `hierarchical`, and `orderby` can be passed, instead of just `format`. The defaults for `get_comments()` include `status = 'all'` and `orderby = ''` - which is no bueno.
For threaded comments, we need comments to be retrieved within bounds, so logged-out users don't see unmoderated comments on the front end, etc.
Updates unit tests.
See <a href="https://core.trac.wordpress.org/ticket/8071">#8071</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpcommentphp">trunk/src/wp-includes/class-wp-comment.php</a></li>
<li><a href="#trunksrcwpincludescommenttemplatephp">trunk/src/wp-includes/comment-template.php</a></li>
<li><a href="#trunktestsphpunittestscommentqueryphp">trunk/tests/phpunit/tests/comment/query.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpcommentphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-comment.php 2015-09-26 00:39:51 UTC (rev 34568)
+++ trunk/src/wp-includes/class-wp-comment.php 2015-09-26 02:24:17 UTC (rev 34569)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -227,22 +227,61 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @access public
</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 $format Return value format. 'tree' for a hierarchical tree, 'flat' for a flattened array.
- * Default 'tree'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args {
+ * Array of arguments used to pass to get_comments() and determine format.
+ *
+ * @type string $format Return value format. 'tree' for a hierarchical tree, 'flat' for a flattened array.
+ * Default 'tree'.
+ * @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 $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: 'threaded'.
+ * @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.
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array Array of `WP_Comment` objects.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function get_children( $format = 'tree' ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function get_children( $args = array() ) {
+ $defaults = array(
+ 'format' => 'tree',
+ 'status' => 'all',
+ 'hierarchical' => 'threaded',
+ 'orderby' => '',
+ );
+
+ $_args = wp_parse_args( $args, $defaults );
+ $_args['parent'] = $this->comment_ID;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_null( $this->children ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->children = get_comments( array(
- 'parent' => $this->comment_ID,
- 'hierarchical' => 'threaded',
- ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->children = get_comments( $_args );
</ins><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">- if ( 'flat' === $format ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'flat' === $_args['format'] ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $children = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $this->children as $child ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $children = array_merge( $children, array( $child ), $child->get_children( 'flat' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $child_args = $_args;
+ $child_args['format'] = 'flat';
+ // get_children() resets this value automatically.
+ unset( $child_args['parent'] );
+
+ $children = array_merge( $children, array( $child ), $child->get_children( $child_args ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $children = $this->children;
</span></span></pre></div>
<a id="trunksrcwpincludescommenttemplatephp"></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/comment-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/comment-template.php 2015-09-26 00:39:51 UTC (rev 34568)
+++ trunk/src/wp-includes/comment-template.php 2015-09-26 02:24:17 UTC (rev 34569)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1307,7 +1307,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Trees must be flattened before they're passed to the walker.
</span><span class="cx" style="display: block; padding: 0 10px"> $comments_flat = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $_comments as $_comment ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $comments_flat = array_merge( $comments_flat, array( $_comment ), $_comment->get_children( 'flat' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $comments_flat = array_merge( $comments_flat, array( $_comment ), $_comment->get_children( array(
+ 'format' => 'flat',
+ 'status' => $comment_args['status'],
+ 'orderby' => $comment_args['orderby']
+ ) ) );
</ins><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></span></pre></div>
<a id="trunktestsphpunittestscommentqueryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/comment/query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/comment/query.php 2015-09-26 00:39:51 UTC (rev 34568)
+++ trunk/tests/phpunit/tests/comment/query.php 2015-09-26 02:24:17 UTC (rev 34569)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2023,23 +2023,89 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'comment_parent' => $c5,
</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">- $q = new WP_Comment_Query( array(
- 'post_id' => $this->post_id,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args = array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'hierarchical' => 'threaded',
</span><span class="cx" style="display: block; padding: 0 10px"> 'orderby' => 'comment_ID',
</span><span class="cx" style="display: block; padding: 0 10px"> 'order' => 'ASC',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ );
+
+ $query_args = array_merge( $args, array(
+ 'post_id' => $this->post_id,
</ins><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $q = new WP_Comment_Query( $query_args );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Top-level comments.
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEqualSets( array( $c1, $c5 ), array_values( wp_list_pluck( $q->comments, 'comment_ID' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Direct descendants of $c1.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEqualSets( array( $c2, $c4 ), array_values( wp_list_pluck( $q->comments[ $c1 ]->get_children(), 'comment_ID' ) ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEqualSets( array( $c2, $c4 ), array_values( wp_list_pluck( $q->comments[ $c1 ]->get_children( $args ), 'comment_ID' ) ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Direct descendants of $c2.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEqualSets( array( $c3 ), array_values( wp_list_pluck( $q->comments[ $c1 ]->get_child( $c2 )->get_children(), 'comment_ID' ) ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEqualSets( array( $c3 ), array_values( wp_list_pluck( $q->comments[ $c1 ]->get_child( $c2 )->get_children( $args ), 'comment_ID' ) ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Direct descendants of $c5.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEqualSets( array( $c6 ), array_values( wp_list_pluck( $q->comments[ $c5 ]->get_children(), 'comment_ID' ) ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEqualSets( array( $c6 ), array_values( wp_list_pluck( $q->comments[ $c5 ]->get_children( $args ), 'comment_ID' ) ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @ticket 8071
+ */
+ public function test_hierarchical_threaded_approved() {
+ $c1 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $this->post_id,
+ 'comment_approved' => '1',
+ ) );
+
+ $c2 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $this->post_id,
+ 'comment_approved' => '1',
+ 'comment_parent' => $c1,
+ ) );
+
+ $c3 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $this->post_id,
+ 'comment_approved' => '0',
+ 'comment_parent' => $c2,
+ ) );
+
+ $c4 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $this->post_id,
+ 'comment_approved' => '1',
+ 'comment_parent' => $c1,
+ ) );
+
+ $c5 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $this->post_id,
+ 'comment_approved' => '1',
+ ) );
+
+ $this->factory->comment->create( array(
+ 'comment_post_ID' => $this->post_id,
+ 'comment_approved' => '1',
+ 'comment_parent' => $c5,
+ ) );
+
+ $args = array(
+ 'hierarchical' => 'threaded',
+ 'status' => 'approve',
+ 'orderby' => 'comment_ID',
+ 'order' => 'ASC',
+ );
+
+ $query_args = array_merge( $args, array(
+ 'post_id' => $this->post_id,
+ ) );
+
+ $q = new WP_Comment_Query( $query_args );
+
+ // Top-level comments.
+ $this->assertEqualSets( array( $c1, $c5 ), array_values( wp_list_pluck( $q->comments, 'comment_ID' ) ) );
+
+ // Direct descendants of $c1.
+ $this->assertEqualSets( array( $c2, $c4 ), array_values( wp_list_pluck( $q->comments[ $c1 ]->get_children( $args ), 'comment_ID' ) ) );
+
+ // Direct descendants of $c2.
+ $this->assertEqualSets( array(), array_values( wp_list_pluck( $q->comments[ $c1 ]->get_child( $c2 )->get_children( $args ), 'comment_ID' ) ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>