説明
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
関連
お勧め
meta_compare_key使ってみた(2019年3月19日 更新)
ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。
WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)
今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。
テーマから投稿画像のサイズを指定する(2012年3月15日 更新)
投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。ログインページを変える(2014年9月12日 更新)
WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)
ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。