概要
get_approved_comments関数は、指定された投稿IDに基づいて、承認済みのコメント情報を取得するために使用されます。この関数は、投稿記事のコメント情報を取得する際によく使われます。例えば、コメントのリストを表示したり、特定の条件に基づいたコメントをフィルタリングする場合に便利です。以下のような機能実装で頻繁に利用されます。
- 投稿の記事ページにおけるコメントセクションを作成する
- コメント数をカスタム表示として表示する
- コメントの一覧をカスタマイズして表示する
- テーマのオプションで特定のコメントを表示する
- 特定の条件を満たすコメントを抽出する
- コメントの数に応じて異なるレイアウトやデザインを適用する
- スパムコメントをフィルタリングするロジックの実装
- コメント情報を基にした統計・分析を行う
構文
get_approved_comments( $post_id, $args );
パラメータ
$post_id(int) – コメントを取得する投稿のID（必須）。$args(array) – 取得するコメントに関する追加オプション（省略可能）。
戻り値
- 配列：承認済みのコメントの配列を返します。各コメントはオブジェクトとして表されます。
関連する関数
バージョン情報
get_approved_commentsは、WordPress 1.5.0以降で使用可能です。
コアファイルのパス
wp-includes/comment.php
サンプルコード
サンプルコード1: ポストIDに基づいたコメントの取得
$post_id = 1; // 投稿ID
$comments = get_approved_comments( $post_id );
// 取得したコメントを表示
foreach ( $comments as $comment ) {
echo $comment->comment_content . '<br>';
}
このコードは、指定した投稿IDの承認済みコメントを取得し、そのコメントの内容を表示します。
サンプルコード2: 引数を使ったコメントの取得
$post_id = 2; // 投稿ID
$args = array(
'status' => 'approve',
'type' => 'comment',
);
$comments = get_approved_comments( $post_id, $args );
// コメントの数を表示
echo 'Total Approved Comments: ' . count($comments);
このコードは、特定の投稿IDに対して承認済みのコメントを取得し、そのコメント数を表示します。
サンプルコード3: カスタム条件でのコメント表示
$post_id = 3; // 投稿ID
$args = array(
'order' => 'DESC',
'number' => 5,
);
$comments = get_approved_comments( $post_id, $args );
// 最新の5件のコメントを表示
foreach ( $comments as $comment ) {
echo $comment->comment_author . ': ' . $comment->comment_content . '<br>';
}
このコードは、最新の5件の承認済みコメントを取得し、コメントの著者と内容を表示します。
サンプルコード4: コメントのメタデータを取得
$post_id = 4; // 投稿ID
$comments = get_approved_comments( $post_id );
foreach ( $comments as $comment ) {
$comment_meta = get_comment_meta( $comment->comment_ID );
echo 'Comment by ' . $comment->comment_author . ': ' . $comment_meta['my_custom_meta'][0] . '<br>';
}
このコードは、承認済みのコメント情報を取得し、各コメントに関連するメタデータを表示します。
サンプルコード5: コメントリストのカスタマイズ
$post_id = 5; // 投稿ID
$comments = get_approved_comments( $post_id );
echo '<ul>';
foreach ( $comments as $comment ) {
echo '<li>' . $comment->comment_author . ': ' . $comment->comment_content . '</li>';
}
echo '</ul>';
このコードは、指定した投稿IDの承認済みコメントをリスト形式で表示します。
この関数のアクションでの使用可能性
| アクション名 | 使用可能 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
get_approved_commentsは特定のWordPressバージョンで非推奨または削除されていません。