全てのコメントの情報を取得
全てのコメントの情報を取得するには、get_comments関数を使用します。
構文
| 引数名 | 型 | 初期値 | 説明 | |
|---|---|---|---|---|
| 第一引数 | 絞り込み条件 | string または array |
'' | 取得するコメントを絞り込む条件。 クエリ文字列または連装配列で指定。 省略した場合は全てのコメントを返す。 詳しくは 引数：絞り込む条件の内容 を参照。 |
戻り値
コメントの情報（WP_Commentオブジェクト）をまとめた配列を返します。
（第一引数でcountをtrueに指定した場合は件数を数値で返します。）
コメントの情報（WP_Commentオブジェクト）については 特定のコメントの情報を取得ページをご覧ください。
サンプルコード
引数：絞り込む条件の内容
| キー | 型 | 初期値 | 説明 |
|---|---|---|---|
| author_email | string | '' | コメントの投稿者のメールアドレス。 |
| author_url | string | '' | コメントの投稿者のURL。 |
| author__in | array | '' | 含めるコメントの投稿者のID。 |
| author__not_in | array | '' | 除外するコメントの投稿者のID。 |
| include_unapproved | array | '' | ※ 不明 |
| fields | string | '' | 取得する情報。 指定可能な値は次の通り。 空文字 ... 全てids ... コメントID |
| comment__in | array | '' | 含めるコメントのID。 |
| comment__not_in | array | '' | 除外するコメントのID。 |
| karma | integer | '' | ※ 未使用 |
| number | integer | '' | 取得したいコメントの最大数。 |
| offset | integer | '' | 取得したいコメントの開始位置。 numberが指定されている場合に有効。 インデックス番号で指定。 |
| no_found_rows | boolean | true | ※ 不明 |
| orderby | string|array | '' | 並び替える基準となるコメントの情報（WP_Commentオブジェクト）名。 例： 'comment_ID'カンマまたは半角スペースで区切ることで複数指定することが可能。 複数指定した場合、並び替える方向は全てに適用される。 連装配列でも指定することができ、次のように指定する。 （コメント情報名 => 並び替える方向（order）） 例： array(連装配列の場合はorderは無視される。 |
| order | string | DESC | orderbyの並び替える方向。 orderbyが連装配列の場合は無視される。 指定可能な値は次の通り。 DESC ... 降順ASC ... 昇順 |
| paged | integer | '' | ※ 不明 |
| parent | integer | '' | 親のコメントのID。 |
| parent__in | array | '' | 含める親のコメントのID。 |
| parent__not_in | array | '' | 除外する親のコメントのID。 |
| post_id | integer | 0 | コメントを付けた投稿記事のID。 |
| post__in | array | '' | 含めるコメントを付けた投稿記事のID。 |
| post__not_in | array | '' | 除外するコメントを付けた投稿記事のID。 |
| post_author | integer | '' | コメントを付けた投稿記事の投稿者のID。 |
| post_author__not_in | array | '' | 除外するコメントを付けた投稿記事の投稿者のID。 |
| post_name | string | '' | コメントを付けた投稿記事の投稿名。 |
| post_parent | integer | '' | 親のコメントのID。 |
| post_status | string|array | '' | コメントを付けた投稿記事の状態。 （'publish'や'private'など） |
| post_type | string | '' | コメントを付けた投稿記事の種類。 （'post'や'attackment'など） |
| status | string|array | 'all' | コメントの状態。 （'hold'や'approve'、'spam'、'trash'など） |
| type | string|array | '' | コメントの種類。空またはcomment ... 通常コメントpingback ... ピンバックtrackback ... トラックバック |
| type__in | array | '' | 含めるコメントの種類。 typeとの違いは不明。 |
| type__not_in | array | '' | 除外するコメントの種類。 |
| user_id | integer | '' | コメントの投稿者のID。 登録していない一般的なユーザーは 0。 |
| search | string | '' | コメントを付けた投稿記事に割り当てられているターム名。
|
| count | boolean | false | 取得した件数を取得するかどうか。 戻り値が変化する。 false ... コメント情報true ... 件数のみ |
| meta_key | string | '' | コメントのメタであるカスタムフィールドで絞り込むために指定するキー。 |
| meta_value | string | '' | meta_keyで指定したキーの値。 |
| meta_query | array | '' | WP_Meta_Queryクラスを利用してメタ（カスタムフィールド）で絞り込む。 WP_Meta_Queryクラスで生成したインスタンスを指定する。 |
| date_query | array | null | WP_Date_Queryクラスを利用して日付で絞り込む。 WP_Date_Queryクラスで生成したインスタンスを指定する。 |
| hierarchical | boolean | false | ※ 不明 |
| cache_domain | string | 'core' | ※ 不明 |
| update_comment_meta_cache | boolean | true | ※ 不明 |
| update_comment_post_cache | boolean | false | ※ 不明 |