説明
パラメータ
- $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
関連
お勧め
プラグインのロード順を制御する(2014年6月9日 更新)
これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。
5.3の機能強化:カスタムフィールドキーの条件指定が使いやすくなる(2019年11月19日 更新)
5.3 RC4もリリースされ、正式リリースまであと1週間。5.3の変更点を確認していると、WP_Meta_Queryクラスが変更されていた。これは「Expanded meta key comparison operators in 5.3」で紹介されており、さまざまな条件指定が追加されていた。
HTML entities button:プラグイン作ってみました(2021年4月28日 更新)
以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。更新ボタンの横にスピナーを実装する(2019年5月14日 更新)
WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。
「順序」をtextからnumberに変更してみた(2018年5月27日 更新)
固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。