説明
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
関連
お勧め
自動生成される抜粋からテーブルブロックの内容を除外する(2022年4月6日 更新)
標準テーマである「Twenty Twenty-Two」や「Twenty Twenty-One」では、トップページやアーカイブページにおいて投稿情報を表示する際、その抜粋を使っている。とある投稿にテーブルブロックを入れた際、トップページに表示された抜粋には各セルの内容が列挙され、ちょっとモヤモヤした。
Post-tag automaton:プラグイン作ってみました(2012年12月24日 更新)
みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。ダッシュボードのフィードボックスをカスタマイズ(2011年7月8日 更新)
管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する(管理者権限)。投稿一覧に「投稿フォーマット」フィルターが追加される(2019年4月12日 更新)
WordPress 5.2 Beta2(以降5.2Beta2)のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」(select要素)が追加されていた。
さくらのVPSでKUSANAGI#2(2018年5月27日 更新)
今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。