get_approved_comments() – Function | Developer.WordPress.org

Retrieves the approved comments for a post.

Parameters

$post_idintrequired

The ID of the post.

$argsarrayoptional

See WP_Comment_Query::__construct() for information on accepted arguments.

status int
Comment status to limit results by. Defaults to approved comments.
post_id int
Limit results to those affiliated with a given post ID.
order string
How to order retrieved comments. Default 'ASC'.

Default:array()

Return

WP_Comment[]|int[]|int The approved comments, or number of comments if $count argument is true.

Source

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 );
}

View all references View on Trac View on GitHub

Uses	Description
WP_Comment_Query::__construct()`wp-includes/class-wp-comment-query.php`	Constructor.
wp_parse_args()`wp-includes/functions.php`	Merges user defined arguments into defaults array.

Changelog

Version	Description
4.1.0	Refactored to leverage WP_Comment_Query over a direct query.
2.0.0	Introduced.

User Contributed Notes

Skip to note 2 content

Codex 8 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
Example

In this example we will output a simple list of comment IDs and corresponding post IDs.
```
<?php
   $postID = 1;
   $comment_array = get_approved_comments($postID);

   foreach($comment_array as $comment){
      echo $comment->comment_ID." => ".$comment->comment_post_ID."\n";
   }
?>
```
Log in to add feedback

get_approved_comments( int $post_id, array $args = array() ): WP_Comment[]|int[]|int

In this article

Parameters

Return

Source

Changelog

User Contributed Notes

get_approved_comments( int $post_id, array $args = array() ): WP_Comment[]|int[]|int

In this article

Parameters

Return

Source

Related

Changelog

User Contributed Notes