get_comments

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

説明

array get_comments( [ mixed $args = '' ] )
コメント情報を取得する。

パラメータ

  • $args
    検索条件を指定する連想配列または文字列。文字列で複数のキーワードを指定する場合は'&'で連結する。主なキーワードは次の通り。
    キーワード意味
    author_emailコメント投稿者メールアドレス（省略時は''）
    IDコメントID（省略時は''）
    karmaカルマ（省略時は''）
    number取得したいコメント数（省略時は''）
    offsetコメントの取得位置（省略時は''）
    paged[4.9.0]numberが指定されている場合、そのページ位置を指定（省略時は1）
    orderby並び順を示すフィールド名（複数指定する場合は,で区切る）
    order並び順を示すキーワードとして'DESC'（降順）か'ASC'（昇順）を指定（省略時は'DESC'）
    parent親コメントID（省略時は''）
    parent__in[4.4.0]取得する親コメントIDを配列で指定（省略時は''）
    parent__not_in[4.4.0]取得する対象から除外する親コメントIDを配列で指定（省略時は''）
    post_ID投稿情報ID（省略時は''）
    post_id投稿情報ID（省略時は0）
    post__in取得対象の投稿情報IDを配列で指定（省略時は''）
    post__not_in取得対象から除外する投稿情報IDを配列で指定（省略時は''）
    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'は対象にならないので、注意が必要である。

[4.9.0]パラメータ$argsのキーにpagedが追加された。キーnumberに任意の数値が指定された場合、取得位置を示すページ数となる。なおキーoffsetに0以外の数値が指定された場合はoffsetの値が優先される。

使用例

  • 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

最終更新 : 2023年11月04日 11:26

関連

参考

Code Reference: get_comments

お勧め

Emojin：プラグイン作ってみました（2015年3月21日 更新）

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

Twenty Seventeenのフォントサイズを変更してみた（2021年12月15日 更新）

先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。

HTML entities button：プラグイン作ってみました（2021年4月28日 更新）

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

5.7の機能拡張：エクスポートファイルに更新日時が追加ほか（2021年2月23日 更新）

WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。

query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日 更新）

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。