<!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>[31793] trunk: Improve method consistency in `WP_Comment_Query`.</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/31793">31793</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/31793","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-03-16 14:23:33 +0000 (Mon, 16 Mar 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'>Improve method consistency in `WP_Comment_Query`.
* Introduce a `__construct()` method, which can accept an array of query vars.
* Move query logic out of `query()` method and into a new `get_comments()` method.
* Ensure that `$this->comments` is set whenever `get_comments()` returns a value.
* Introduce a `parse_query()` method, where query vars are parsed with default values and the 'parse_comment_query' action is fired.
These changes bring `WP_Comment_Query` syntax closer to that of `WP_Query`.
Props westonruter, morganestes, boonebgorges.
Fixes <a href="https://core.trac.wordpress.org/ticket/24826">#24826</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescommentphp">trunk/src/wp-includes/comment.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="trunksrcwpincludescommentphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/comment.php 2015-03-16 11:15:34 UTC (rev 31792)
+++ trunk/src/wp-includes/comment.php 2015-03-16 14:23:33 UTC (rev 31793)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -220,7 +220,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database abstraction object.
</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|array $args Optional. Array or string of arguments. See {@see WP_Comment_Query::query()}
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|array $args Optional. Array or string of arguments. See {@see WP_Comment_Query::parse_query()}
</ins><span class="cx" style="display: block; padding: 0 10px"> * for information on accepted arguments. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return int|array List of comments or number of found comments if `$count` argument is true.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -265,13 +265,30 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $date_query = false;
</span><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">+ * Query vars set by the user.
+ *
+ * @since 3.1.0
+ * @access public
</ins><span class="cx" style="display: block; padding: 0 10px"> * @var array
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public $query_vars;
</span><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">+ * Default values for query vars.
+ *
+ * @since 4.2.0
+ * @access public
</ins><span class="cx" style="display: block; padding: 0 10px"> * @var array
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public $query_var_defaults;
+
+ /**
+ * List of comments located by the query.
+ *
+ * @since 4.0.0
+ * @access public
+ * @var array
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public $comments;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -292,15 +309,68 @@
</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">- * Execute the query
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Constructor.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 3.1.0
- * @since 4.1.0 Introduced 'comment__in', 'comment__not_in', 'post_author__in',
- * 'post_author__not_in', 'author__in', 'author__not_in', 'post__in',
- * 'post__not_in', 'include_unapproved', 'type__in', and 'type__not_in'
- * arguments to $query_vars.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Sets up the comment query, based on the query vars passed.
</ins><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|array $query_vars {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.2.0
+ * @access public
+ *
+ * @param string $query URL query string.
+ * @return WP_Comment_Query
+ */
+ public function __construct( $query = '' ) {
+ $this->query_var_defaults = array(
+ 'author_email' => '',
+ 'author__in' => '',
+ 'author__not_in' => '',
+ 'include_unapproved' => '',
+ 'fields' => '',
+ 'ID' => '',
+ 'comment__in' => '',
+ 'comment__not_in' => '',
+ 'karma' => '',
+ 'number' => '',
+ 'offset' => '',
+ 'orderby' => '',
+ 'order' => 'DESC',
+ 'parent' => '',
+ 'post_author__in' => '',
+ 'post_author__not_in' => '',
+ 'post_ID' => '',
+ 'post_id' => 0,
+ 'post__in' => '',
+ 'post__not_in' => '',
+ 'post_author' => '',
+ 'post_name' => '',
+ 'post_parent' => '',
+ 'post_status' => '',
+ 'post_type' => '',
+ 'status' => 'all',
+ 'type' => '',
+ 'type__in' => '',
+ 'type__not_in' => '',
+ 'user_id' => '',
+ 'search' => '',
+ 'count' => false,
+ 'meta_key' => '',
+ 'meta_value' => '',
+ 'meta_query' => '',
+ 'date_query' => null, // See WP_Date_Query
+ );
+
+ if ( ! empty( $query ) ) {
+ $this->query( $query );
+ }
+ }
+
+ /**
+ * Parse arguments passed to the comment query with default query parameters.
+ *
+ * @since 4.2.0 Extracted from {@link WP_Comment_Query::query()}.
+ * @access public
+ *
+ * @param string|array $query {
</ins><span class="cx" style="display: block; padding: 0 10px"> * Optional. Array or query string of comment query parameters.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $author_email Comment author email address. Default empty.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -363,53 +433,49 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array $type__not_in Exclude comments from a given array of comment types. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $user_id Include comments for a specific user ID. 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">- * @return int|array Array of comments or number of found comments if `$count` is set to true.
</del><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 query( $query_vars ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function parse_query( $query = '' ) {
+ if ( empty( $query ) ) {
+ $query = $this->query_vars;
+ }
+
+ $this->query_vars = wp_parse_args( $query, $this->query_var_defaults );
+ do_action_ref_array( 'parse_comment_query', array( &$this ) );
+ }
+
+ /**
+ * Sets up the WordPress query for retrieving comments.
+ *
+ * @since 3.1.0
+ * @since 4.1.0 Introduced 'comment__in', 'comment__not_in', 'post_author__in',
+ * 'post_author__not_in', 'author__in', 'author__not_in', 'post__in',
+ * 'post__not_in', 'include_unapproved', 'type__in', and 'type__not_in'
+ * arguments to $query_vars.
+ * @since 4.2.0 Moved parsing to {@link WP_Comment_Query::parse_query()}.
+ * @access public
+ *
+ * @param string|array $query Array or URL query string of parameters.
+ * @return array List of comments.
+ */
+ public function query( $query ) {
+ $this->query_vars = wp_parse_args( $query );
+ return $this->get_comments();
+ }
+
+ /**
+ * Get a list of comments matching the query vars.
+ *
+ * @since 4.2.0
+ * @access public
+ *
+ * @return array The list of comments.
+ */
+ public function get_comments() {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $defaults = array(
- 'author_email' => '',
- 'author__in' => '',
- 'author__not_in' => '',
- 'include_unapproved' => '',
- 'fields' => '',
- 'ID' => '',
- 'comment__in' => '',
- 'comment__not_in' => '',
- 'karma' => '',
- 'number' => '',
- 'offset' => '',
- 'orderby' => '',
- 'order' => 'DESC',
- 'parent' => '',
- 'post_author__in' => '',
- 'post_author__not_in' => '',
- 'post_ID' => '',
- 'post_id' => 0,
- 'post__in' => '',
- 'post__not_in' => '',
- 'post_author' => '',
- 'post_name' => '',
- 'post_parent' => '',
- 'post_status' => '',
- 'post_type' => '',
- 'status' => 'all',
- 'type' => '',
- 'type__in' => '',
- 'type__not_in' => '',
- 'user_id' => '',
- 'search' => '',
- 'count' => false,
- 'meta_key' => '',
- 'meta_value' => '',
- 'meta_query' => '',
- 'date_query' => null, // See WP_Date_Query
- );
-
</del><span class="cx" style="display: block; padding: 0 10px"> $groupby = '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->query_vars = wp_parse_args( $query_vars, $defaults );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->parse_query();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Parse meta query
</span><span class="cx" style="display: block; padding: 0 10px"> $this->meta_query = new WP_Meta_Query();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -428,8 +494,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action_ref_array( 'pre_get_comments', array( &$this ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // $args can be whatever, only use the args defined in defaults to compute the key
- $key = md5( serialize( wp_array_slice_assoc( $this->query_vars, array_keys( $defaults ) ) ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // $args can include anything. Only use the args defined in the query_var_defaults to compute the key.
+ $key = md5( serialize( wp_array_slice_assoc( $this->query_vars, array_keys( $this->query_var_defaults ) ) ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $last_changed = wp_cache_get( 'last_changed', 'comment' );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $last_changed ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $last_changed = microtime();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -438,7 +504,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $cache_key = "get_comments:$key:$last_changed";
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $cache = wp_cache_get( $cache_key, 'comment' ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $cache;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->comments = $cache;
+ return $this->comments;
</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"> $where = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -826,7 +893,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_add( $cache_key, $comments, 'comment' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $comments;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->comments = $comments;
+ return $this->comments;
</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-03-16 11:15:34 UTC (rev 31792)
+++ trunk/tests/phpunit/tests/comment/query.php 2015-03-16 14:23:33 UTC (rev 31793)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1587,4 +1587,49 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEqualSets( array_merge( $c1, $c3 ), $found );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @ticket 24826
+ */
+ public function test_comment_query_object() {
+ $comment_id = $this->factory->comment->create();
+
+ $query1 = new WP_Comment_Query();
+ $this->assertNull( $query1->query_vars );
+ $this->assertEmpty( $query1->comments );
+ $comments = $query1->query( array( 'status' => 'all' ) );
+ $this->assertInternalType( 'array', $query1->query_vars );
+ $this->assertNotEmpty( $query1->comments );
+ $this->assertInternalType( 'array', $query1->comments );
+
+ $query2 = new WP_Comment_Query( array( 'status' => 'all' ) );
+ $this->assertNotEmpty( $query2->query_vars );
+ $this->assertNotEmpty( $query2->comments );
+ $this->assertEquals( $query2->comments, $query1->get_comments() );
+ }
+
+ /**
+ * @ticket 22400
+ */
+ public function test_comment_cache_key_should_ignore_custom_params() {
+ global $wpdb;
+
+ $p = $this->factory->post->create();
+ $c = $this->factory->comment->create( array( 'comment_post_ID' => $p ) );
+
+ $q1 = new WP_Comment_Query();
+ $q1->query( array(
+ 'post_id' => $p,
+ ) );
+
+ $num_queries = $wpdb->num_queries;
+
+ $q2 = new WP_Comment_Query();
+ $q2->query( array(
+ 'post_id' => $p,
+ 'foo' => 'bar',
+ ) );
+
+ $this->assertSame( $num_queries, $wpdb->num_queries );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>