get_comments

（2.7.0以降）
get_comments - コメント情報を取得する

説明

array get_comments( [ mixed $args = '' ] )

コメント情報を取得する。

パラメータ

$args

検索条件を指定する連想配列または文字列。文字列で複数のキーワードを指定する場合は'&'で連結する。主なキーワードは次の通り。

キーワード	意味
author_email	コメント投稿者メールアドレス（省略時は''）
ID	コメントID（省略時は''）
karma	カルマ（省略時は''）
number	取得したいコメント数（省略時は''）
offset	コメントの取得位置（省略時は''）
orderby	並び順を示すフィールド名（複数指定する場合は,で区切る）
order	並び順を示すキーワードとして'DESC'（降順）か'ASC'（昇順）を指定（省略時は'DESC'）
parent	親コメントID（省略時は''）
post_ID	投稿情報ID（省略時は''）
post_id	投稿情報ID（省略時は0）
status	'hold'、'approve'、'spam'、'trash'などのコメントステータス（省略時は''）
type	'comment'、'pings'、'pingback'などのコメント種別（省略時は''）
user_id	ユーザID（省略時は''）
count	条件にマッチした件数を取得する場合はtrue、コメント情報そのものを取得する場合はfalse（省略時はfalse）
search	コメント投稿者の名前、メールアドレス、URL、IPアドレスまたはコメント内容を部分一致するキーワード（省略時は''）
post_author	コメント元投稿の投稿者名（省略時は''）
post_name	コメント元投稿の投稿名（省略時は''、タイトルではない）
post_parent	コメント元投稿の親投稿ID（省略時は''）
post_status	'publish'、'private'などのコメント元投稿の投稿ステータス（省略時は''）
post_type	'post'、'attackment'などのコメント元投稿の投稿タイプ（省略時は''）
meta_key	検索・並び替えを行うコメントメタ情報のキー名（省略時は''）
meta_value	検索するコメントメタ情報の値（省略時は''）
meta_query	コメントメタ情報の検索条件を配列で指定（省略時は''）
date_query	日時検索条件の配列を指定（省略時はnull）

返り値

条件にマッチしたコメントデータ（オブジェクト）が格納された配列を返す。コメントデータの内容は次の通り。

フィールド名	意味
comment_ID	コメントID
comment_post_ID	コメントされた投稿情報のID
comment_author	コメント投稿者
comment_author_email	コメント投稿者のメールアドレス
comment_author_url	コメント投稿者のWebページURL
comment_author_IP	コメント投稿時のIPアドレス
comment_date	コメント投稿日時
comment_date_gmt	コメント投稿日時（GMT時間）
comment_content	コメント内容
comment_karma	カルマ
comment_approved	承認状態
comment_agent	ユーザエージェント
comment_type	コメント種別
comment_parent	親コメントのID
user_id	コメント投稿者のユーザID（サイトアカウント保持者でログイン状態でコメント投稿した場合）

注意

post_idを省略した（または0を指定した）場合は、すべてのコメント情報が対象とし、author_emailやkarmaなどにより絞り込みを行う。statusを省略した場合は、'hold'または'approve'が対象となり、'spam'や'trash'は対象にならないので、注意が必要である。

使用例

IDが10の投稿ページのコメント情報を5件分取得する（文字列指定）。
<?php $comments = get_comments( 'post_id=10&number=5' ); ?>
IDが10の投稿ページのコメント情報を5件分取得する（配列指定）。
<?php $comments = get_comments( array( 'post_id' => 10, 'number' => 5 ) ); ?>