apply_filters( 'comments_template_top_level_query_args', array $top_level_args )

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$top_level_argsarray

{ The top level query arguments for the comments template.
@type bool $count Whether to return a comment count.
@type string|array $orderby The field(s) to order by.
@type int $post_id The post ID.
@type string|array $status The comment status to limit results by.
}

• $countbool

  Whether to return a comment count.

• $orderbystring|array

  The field(s) to order by.

• $post_idint

  The post ID.

• $statusstring|array

  The comment status to limit results by.

Where this hook fires · 1

• wp-includes/comment-template.php:1524comments_template()

Source code

View on Trac ↗View on GitHub ↗

1518			 *     @type bool         $count   Whether to return a comment count.1519			 *     @type string|array $orderby The field(s) to order by.1520			 *     @type int          $post_id The post ID.1521			 *     @type string|array $status  The comment status to limit results by.1522			 * }1523			 */1524			$top_level_args = apply_filters( 'comments_template_top_level_query_args', $top_level_args );1525 1526			$top_level_count = $top_level_query->query( $top_level_args );1527 1528			$comment_args['offset'] = ( (int) ceil( $top_level_count / $per_page ) - 1 ) * $per_page;1529		}1530	}

Changelog

Introduced in 5.6.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.