get_comments( string|array $args = '' )

Retrieve a list of comments.

Description
- Parameters
- Return
- Source
- Changelog
Related
- Uses
- Used By
User Contributed Notes

Description Description

The comment list can be for the blog as a whole or for an individual post.

Parameters Parameters

$args

(string|array) (Optional) Array or string of arguments. See WP_Comment_Query::__construct() for information on accepted arguments.

Default value: ''

Top ↑

Return Return

(int|array) List of comments or number of found comments if $count argument is true.

Top ↑

Source Source

File: wp-includes/comment.php

function get_comments( $args = '' ) {
	$query = new WP_Comment_Query;
	return $query->query( $args );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version	Description
2.7.0	Introduced.

Top ↑

Uses Uses

Uses
Uses	Description
wp-includes/class-wp-comment-query.php: WP_Comment_Query::__construct()	Constructor.

Top ↑

Used By Used By

Used By
Used By	Description
wp-includes/blocks/latest-comments.php: render_block_core_latest_comments()	Renders the `core/latest-comments` block on server.
wp-includes/comment.php: wp_comments_personal_data_exporter()	Finds and exports personal data associated with an email address from the comments table.
wp-includes/comment.php: wp_comments_personal_data_eraser()	Erases personal data associated with an email address from the comments table.
wp-includes/class-wp-comment.php: WP_Comment::get_children()	Get the children of a comment.
wp-includes/class-wp-comment-query.php: WP_Comment_Query::fill_descendants()	Fetch descendants for located comments.
wp-admin/includes/dashboard.php: wp_dashboard_recent_comments()	Show Comments section.
wp-admin/includes/meta-boxes.php: post_comment_meta_box()	Display comments for post.
wp-admin/includes/class-wp-comments-list-table.php: WP_Comments_List_Table::get_views()
wp-admin/includes/class-wp-comments-list-table.php: WP_Comments_List_Table::prepare_items()
wp-includes/widgets/class-wp-widget-recent-comments.php: WP_Widget_Recent_Comments::widget()	Outputs the content for the current Recent Comments widget instance.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getComments()	Retrieve comments.
wp-includes/comment-template.php: wp_list_comments()	List comments.

Show 7 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

Skip to note 1 content

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

Contributed by Codex — 3 years ago
Show comment counts of a post
```
$args = array(
	'post_id' => 1,   // Use post_id, not post_ID
        'count'   => true // Return only the count
);
$comments_count = get_comments( $args );
echo $comments_count;
```
Log in to add feedback
Skip to note 2 content

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

Contributed by Codex — 3 years ago
Example
```
$comments = get_comments( array( 'post_id' => 15 ) );

foreach ( $comments as $comment ) :
	echo $comment->comment_author;
endforeach;
```
Log in to add feedback

-1

Contributed by Codex — 3 years ago

Show last 5 unapproved comments

$args = array(
	'status'  => 'hold',
	'number'  => '5',
	'post_id' => 1, // use post_id, not post_ID
);
$comments = get_comments( $args );

foreach ( $comments as $comment ) :
	echo $comment->comment_author . '<br />' . $comment->comment_content;
endforeach;

Skip to note 4 content

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

Contributed by Codex — 3 years ago
Show comment counts of a user
```
$args = array(
	'user_id' => 1,   // Use user_id.
	'count'   => true // Return only the count.
);
$comments_count = get_comments( $args );

echo $comments_count;
```
Log in to add feedback
Skip to note 5 content

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

Contributed by Codex — 3 years ago
Show comments of a user
```
<?php
$args = array(
	'user_id' => 1, // use user_id
);
$comments = get_comments( $args );

foreach ( $comments as $comment ) :
	echo $comment->comment_author . '<br />' . $comment->comment_content;
endforeach;
```
Log in to add feedback
Skip to note 6 content

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

Contributed by Codex — 3 years ago
Get comments from last 4 weeks
```
$args = array(
	'date_query' => array(
		'after' => '4 weeks ago',
		'before' => 'tomorrow',
		'inclusive' => true,
	),
);

$comments = get_comments( $args );
foreach ( $comments as $comment ) {
	// Output comments etc here
}
```
Log in to add feedback

You must log in before being able to contribute a note or feedback.

WordPress.org

Code Reference

get_comments( string|array $args = '' )

Contents

Description Description

Parameters Parameters

Return Return

Source Source

Changelog Changelog

User Contributed Notes User Contributed Notes

WordPress.org

get_comments( string|array $args = '' )

Contents

Description #Description

Parameters #Parameters

Return #Return

Source #Source

Changelog #Changelog

Related #Related

Uses #Uses

Used By #Used By

User Contributed Notes #User Contributed Notes

Description Description

Parameters Parameters

Return Return

Source Source

Changelog Changelog

Related Related

Uses Uses

Used By Used By

User Contributed Notes User Contributed Notes