WP_Comment_Query()


WordPressのWP_Comment_Query()関数は、コメントを取得するための柔軟なクエリを実行するために使用されます。

構文

WP_Comment_Query( array $args );
  • $args (array) — コメントを取得するための条件を設定する連想配列。

$argsの主なキー:

  • author_email (string) — 特定のメールアドレスを持つコメントを取得。
  • status (string) — コメントのステータスを指定。例: 'approve', 'hold', 'spam'。
  • post_id (int) — 特定の投稿IDのコメントを取得。
  • number (int) — 取得するコメントの数。
  • orderby (string) — コメントの並べ替え基準。例: 'date', 'author', 'post_id'。

例 1: 投稿IDに基づいてコメントを取得

投稿IDに関連するすべてのコメントを取得します。

<?php
$args = array(
    'post_id' => get_the_ID(),
);
$query = new WP_Comment_Query( $args );
$comments = $query->get_comments();
?>

例 2: 特定のメールアドレスのコメントを取得

特定の著者メールを持つコメントを取得します。

<?php
$args = array(
    'author_email' => 'example@example.com',
);
$query = new WP_Comment_Query( $args );
$comments = $query->get_comments();
?>

例 3: 承認されたコメントのみを取得

ステータスが「承認」のコメントを取得します。

<?php
$args = array(
    'status' => 'approve',
);
$query = new WP_Comment_Query( $args );
$comments = $query->get_comments();
?>

例 4: コメントを日付で並べ替える

コメントを日付順で取得します。

<?php
$args = array(
    'orderby' => 'date',
    'order' => 'DESC',
);
$query = new WP_Comment_Query( $args );
$comments = $query->get_comments();
?>

例 5: 最大5件のコメントを取得

取得するコメントの数を制限します。

<?php
$args = array(
    'number' => 5,
);
$query = new WP_Comment_Query( $args );
$comments = $query->get_comments();
?>

注意点

  • WP_Comment_Queryを使用する際には、適切な条件を設定してパフォーマンスを考慮してください。

関連機能：