Function Reference/get comments
Description
Retrieve a list of comments.
Usage
<?php get_comments( $args ); ?>
Default Usage
<?php $defaults = array(
'author_email' => ,
'ID' => ,
'karma' => ,
'number' => ,
'offset' => ,
'orderby' => ,
'order' => 'DESC',
'parent' => ,
'post_id' => ,
'status' => ,
'type' => ,
'user_id' => ); ?>
Parameters
- $status
- (string) (optional) Only return comments with this status.
- 'hold' - unapproved comments
- 'approve' - approved comments
- 'spam' - spam comments
- 'trash' - trash comments
- Default: None
- $orderby
- (string) (optional) Set the field used to sort comments.
- Default: comment_date_gmt
- $order
- (string) (optional) How to sort $orderby. Valid values:
- 'ASC' - Ascending (lowest to highest).
- 'DESC' - Descending (highest to lowest).
- Default: DESC
- $number
- (integer) (optional) Number of comments to return. Leave blank to return all comments.
- Default: unlimited
- $offset
- (integer) (optional) Offset from latest comment. You must include $number along with this.
- Default: 0
- $post_id
- (integer) (optional) Only return comments for a particular post or page.
- Default: None
Returns
- (Array)
- Comment objects with the following indexes:
- comment_ID
- (integer) The comment ID
- comment_post_ID
- (integer) The ID of the post/page that this comment responds to
- comment_author
- (string) The comment author's name
- comment_author_email
- (string) The comment author's email
- comment_author_url
- (string) The comment author's webpage
- comment_author_IP
- (string) The comment author's IP
- comment_date
- (string) The datetime of the comment (YYYY-MM-DD HH:MM:SS)
- comment_date_gmt
- (string) The GMT datetime of the comment (YYYY-MM-DD HH:MM:SS)
- comment_content
- (string) The comment's content
- comment_karma
- (integer) The comment's karma
- comment_approved
- (string) The comment approval level (0, 1 or "spam")
- comment_agent
- (string) The commenter's user agent (browser, operating system, etc.)
- comment_type
- (string) The comment's type if meaningfull (pingback|trackback), empty for normal comments
- comment_parent
- (string) The parent comment's ID for nested comments (0 for top level)
- user_id
- (integer) The comment author's ID if s/he is registered (0 otherwise)
Examples
<?php
$comments = get_comments('post_id=15');
foreach($comments as $comment) :
echo($comment->comment_author);
endforeach;
?>
Show last 5 unapproved comments:
<?php
$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;
?>
Source File
get_comments() is located in wp-includes/comment.php.
Related
