ワードプレスのget_comment関数の使用方法・解説

概要

get_comment関数は、特定のコメントの情報を取得するために使用されるWordPressの関数です。この関数を使うことで、コメントの作者、内容、日付などを簡単に取得できます。一般的に、この関数は以下のような機能を実装する際によく使われます。

1. コメントセクションの表示
2. コメントのメタデータ表示
3. 特定のコメントに関連する情報を取得
4. コメント一覧のカスタマイズ
5. コメントの編集/削除機能の実装
6. コメントの承認状態の管理
7. 特定のコメントの所有者情報の表示
8. コメントの返信機能を実装

構文

get_comment( $comment_ID, $output );

パラメータ

• $comment_ID (int) – 取得するコメントのID。
• $output (string) – 返される配列またはオブジェクトの形式。デフォルトは 'object'。

戻り値

指定したコメントの情報が含まれるオブジェクトまたは配列、またはコメントが見つからない場合は null を返します。

関連する関数

• get_comments
• wp_list_comments
• comment_text

使用可能なバージョン

get_comment関数は、WordPressのバージョン2.0.0以降で利用可能です。

コアファイルのパス

/wp-includes/comment.php

この関数のアクションでの使用可能性

アクション	使用例
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	〇

サンプルコード

サンプル1: コメントの取得と表示

このサンプルコードは、特定のコメントを取得し、その内容を表示します。

$comment_id = 1; // 取得したいコメントのID
$comment = get_comment( $comment_id );

if ( $comment ) {
    echo 'コメント内容: ' . $comment->comment_content;
}

サンプル2: コメントのメタデータを取得

このサンプルは、コメントのメタデータ（作者名や日付）を取得して表示します。

$comment_id = 1; // 取得したいコメントのID
$comment = get_comment( $comment_id );

if ( $comment ) {
    echo '作者: ' . $comment->comment_author;
    echo '投稿日: ' . $comment->comment_date;
}

サンプル3: 複数のコメントの情報を表示

このサンプルは、コメントのIDリストからそれぞれのコメント情報を取得して表示します。

$comment_ids = [1, 2, 3]; // 取得したいコメントのIDリスト
foreach ( $comment_ids as $comment_id ) {
    $comment = get_comment( $comment_id );
    echo 'コメント内容: ' . $comment->comment_content . '<br>';
}

サンプル4: コメントの存在確認

このサンプルは、指定したコメントが存在するかどうかを確認します。

$comment_id = 1; // 確認するコメントのID
if ( get_comment( $comment_id ) ) {
    echo 'このコメントは存在します。';
} else {
    echo 'このコメントは存在しません。';
}

サンプル5: コメント情報の取得と処理

このサンプルは、取得したコメント情報を利用してカスタム処理を行います。

$comment_id = 1; // 取得したいコメントのID
$comment = get_comment( $comment_id );

if ( $comment ) {
    // 特定の条件に応じた処理
    if ( $comment->comment_approved == '1' ) {
        echo '承認されたコメント: ' . $comment->comment_content;
    } else {
        echo '未承認のコメント。';
    }
}