説明
パラメータ
- $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
関連
お勧め
6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)
バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。
固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)
固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。
Fotepo:プラグイン作ってみました(2019年9月19日 更新)
仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。
カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)
サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。