get_comment_meta() の説明と使用例

WordPress関数get_comment_meta()は、特定のコメントに関連付けられたメタデータを取得するために使用されます。

構文

get_comment_meta( int $comment_id, string $key = '', bool $single = false );

引数の説明:

$comment_id (int) — メタデータを取得する対象のコメントのID。
$key (string) — 取得する特定のメタキー。省略すると、すべてのメタデータが返されます。
$single (bool) — trueの場合、単一の値を返します。falseの場合、配列として返されます。

例 1: 特定のコメントのメタデータを取得する

特定のコメントのメタデータを取得する基本的な例です。

$meta_value = get_comment_meta( get_the_ID(), 'custom_key', true );

例 2: コメントのすべてのメタデータを取得する

コメントに関連付けられているすべてのメタデータを配列で取得します。

$all_meta = get_comment_meta( get_the_ID() );

例 3: メタデータが存在するか確認する

特定のメタデータが存在するか確認し、存在する場合に出力します。

if ( get_comment_meta( get_the_ID(), 'custom_key', true ) ) {
    echo 'メタデータが存在します。';
}

例 4: デフォルト値を設定する

メタデータが存在しない場合にデフォルト値を設定して取得します。

$meta_value = get_comment_meta( get_the_ID(), 'custom_key', true ) ?: 'デフォルト値';

例 5: すべてのコメントのメタデータをループで取得する

すべてのコメントのメタデータをループで取得する例です。

$comments = get_comments();
foreach ( $comments as $comment ) {
    $meta_value = get_comment_meta( $comment->comment_ID, 'custom_key', true );
    echo $meta_value;
}

注意事項

get_comment_meta()を使用する際は、正しい$comment_idを指定してください。
$single引数を適切に設定し、意図した形式で値を取得することを確認してください。

構文