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

フィルター

直接実行するフィルターはありません(3.1以降はWP_Comment_Queryクラス参照)。

アクション

直接実行するアクションはありません(3.1以降はWP_Comment_Queryクラス参照)。

ソースファイル

/wp-includes/comment.php

最終更新 : 2018年05月27日 10:51



お勧め

HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

3.2標準テーマ「Twenty Eleven」は投稿フォーマットに着目(2011年7月6日 更新)

新テーマ「Twenty Eleven」のトップページでは、投稿フォーマットに応じて表示を切り替える仕組みが提案されている。ここでは、その投稿フォームの活用方法を簡単に紹介する。

標準で使用できる数少ないショートコード[caption]とは(2018年5月27日 更新)

画像をアップロードして「投稿に追加」ボタンをクリックすると、投稿記事内にリンク付きのimgタグか、ショートコードのが挿入される。ここではそれらの書式を整理する。

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。