Changeset 34730 for trunk/src/wp-includes/class-wp-comment.php

Timestamp:

10/01/2015 03:57:53 AM (9 years ago)

Author:

boonebgorges

Message:

Prevent extra db queries in WP_Comment::get_children().

WP_Comment_Query::fill_descendants() queries for a comment tree in a way that
minimizes database overhead, and places the located descendants with their
proper parents. However, it doesn't touch leaf nodes - comments with no
children - so future calls to get_children() on those comment objects
result in unnecessary database queries. To prevent this, fill_descendants()
now sets a populated_children flag on all located WP_Comment objects.

See #8071.

File:

• trunk/src/wp-includes/class-wp-comment.php (modified) (3 diffs)

trunk/src/wp-includes/class-wp-comment.php

@@ -158 +158 @@
      */
     protected $children;
+
+    /**
+     * Whether children have been populated for this comment object.
+     *
+     * @since 4.4.0
+     * @access protected
+     * @var bool
+     */
+    protected $populated_children = false;
 
     /**
@@ -280 +289 @@
 
         if ( is_null( $this->children ) ) {
-            $this->children = get_comments( $_args );
+            if ( $this->populated_children ) {
+                $this->children = array();
+            } else {
+                $this->children = get_comments( $_args );
+            }
         }
 
@@ -332 +345 @@
 
     /**
+     * Set the 'populated_children' flag.
+     *
+     * This flag is important for ensuring that calling `get_children()` on a childless comment will not trigger
+     * unneeded database queries.
+     *
+     * @since 4.4.0
+     */
+    public function populated_children( $set ) {
+        $this->populated_children = (bool) $set;
+    }
+
+    /**
      * Check whether a non-public property is set.
      *