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



お勧め

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

5.3の新機能:サイト管理者のメールアドレスを定期的に確認する(2019年9月27日 更新)

WordPress 5.3 Beta 1」に記載されていた「Admin Email Verification」の項目が目に留まる。管理者のメールアドレスを定期的に確認するという仕組みがどんなものなのか気になったので、ちょっと調べてみた。

3.6リリース直前チェック(2013年7月26日 更新)

$wpdbは、WordPressのデータベースにアクセスする際に使用できる便利なオブジェクト。独自テーブルの利用やデータ検索の最適化など、標準提供される関数では実現できないことを手助けしてくれる。そんな$wpdbのescapeメソッドが3.6で非推奨(deprecated)になる。

固定ページを投稿ページ用テンプレートファイル(single.php)で表示する(2013年7月31日 更新)

固定ページと投稿ページのデザインが共通の場合、同じ内容のsingle.phpとpage.phpを用意すれば事足りるが、デザインの修正時は二度手間になってしまう。そこで、固定ページをsingle.phpで表示するようにできないか考えてみた。

購読者は管理者ページのアクセス禁止(2013年11月12日 更新)

購読者(subscriber)は、通常「ダッシュボード」「プロフィール」にアクセスできるが、今回はプロフィールを独自に管理する準備を兼ねて、これらのページにアクセスできないようにブロックしてみた。