Make WordPress Core

Ticket #38074: 38074.2.diff

File 38074.2.diff, 1.1 KB (added by garrett-eclipse, 4 years ago)

Update the docblock to improve the descriptions and add a description to the array.

  • src/wp-includes/comment-template.php

     
    14341434                                $top_level_args['include_unapproved'] = $comment_args['include_unapproved'];
    14351435                        }
    14361436
     1437                        /**
     1438                         * Filters the arguments used in the top level comments query.
     1439                         *
     1440                         * @since 5.6.0
     1441                         *
     1442                         * @see WP_Comment_Query::__construct()
     1443                         *
     1444                         * @param array $top_level_args {
     1445                         *     The top level query arguments for the comments template.
     1446                         *
     1447                         *     @type bool         $count   Whether to return a comment count.
     1448                         *     @type string|array $orderby The field(s) to order by.
     1449                         *     @type int          $post_id The post ID.
     1450                         *     @type string|array $status  The comment status to limit results by.
     1451                         * }
     1452                         */
     1453                        $top_level_args = apply_filters( 'comments_template_top_level_query_args', $top_level_args );
     1454
    14371455                        $top_level_count = $top_level_query->query( $top_level_args );
    14381456
    14391457                        $comment_args['offset'] = ( ceil( $top_level_count / $per_page ) - 1 ) * $per_page;