Context Navigation

← Previous Change
Next Change →

class-wp-comment.php

Timestamp:

09/26/2015 02:24:17 AM (11 years ago)

Author:

wonderboymusic

Message:

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 #8071.

File:

: 1 edited

trunk/src/wp-includes/class-wp-comment.php (modified) (1 diff)

Legend:

: Unmodified
: Added
: Removed

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

-              r34561
+              r34569
          * @access public
+         *
+         * @param string $format Return value format. 'tree' for a hierarchical tree, 'flat' for a flattened array.
+         *                       Default 'tree'.
+         * @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.
+         * }
          * @return array Array of `WP_Comment` objects.
          */
+        public function get_children( $format = 'tree' ) {
+        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;
                 if ( is_null( $this->children ) ) {
+                        $this->children = get_comments( array(
+                                'parent' => $this->comment_ID,
+                                'hierarchical' => 'threaded',
+                        ) );
+                }
+                if ( 'flat' === $format ) {
+                        $this->children = get_comments( $_args );
+                }
+                if ( 'flat' === $_args['format'] ) {
                         $children = array();
                         foreach ( $this->children as $child ) {
+                                $children = array_merge( $children, array( $child ), $child->get_children( 'flat' ) );
+                                $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 ) );
+                        }
                 } else {

Note: See TracChangeset for help on using the changeset viewer.

Make WordPress Core

Context Navigation

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

Legend:

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

Download in other formats: