get_approved_comments() WordPress Function
The get_approved_comments() function retrieves all approved comments for a given post. Approved comments are those that have been approved by a moderator or administrator. This function is useful for retrieving comments that are safe to display to visitors.
get_approved_comments( int $post_id, array $args = array() ) #
Retrieves the approved comments for post $post_id.
Parameters
- $post_id
(int)(Required)The ID of the post.
- $args
(array)(Optional) See WP_Comment_Query::__construct() for information on accepted arguments.
Default value: array()
Return
(WP_Comment[]|int[]|int) The approved comments, or number of comments if $count argument is true.
Source
File: wp-includes/comment.php
function get_approved_comments( $post_id, $args = array() ) {
if ( ! $post_id ) {
return array();
}
$defaults = array(
'status' => 1,
'post_id' => $post_id,
'order' => 'ASC',
);
$parsed_args = wp_parse_args( $args, $defaults );
$query = new WP_Comment_Query;
return $query->query( $parsed_args );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.1.0 | Refactored to leverage WP_Comment_Query over a direct query. |
| 2.0.0 | Introduced. |