update_comment_meta()

WordPress関数update_comment_meta()は、特定のコメントのメタデータを更新または追加するために使用されます。

構文

update_comment_meta( int $comment_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' );

引数の説明:

• $comment_id (int) — メタデータを更新する対象のコメントID。
• $meta_key (string) — 更新または追加するメタデータのキー名。
• $meta_value (mixed) — 更新後のメタデータの値。
• $prev_value (mixed) — 更新対象の現在の値（オプション）。指定されると、その値が一致した場合のみ更新が行われます。

使用例

例1: コメントにメタデータを追加する

update_comment_meta( get_comment_ID(), 'rating', 5 );

例2: メタデータの値を更新する

update_comment_meta( get_comment_ID(), 'status', 'approved' );

例3: 前の値が一致する場合のみメタデータを更新する

update_comment_meta( get_comment_ID(), 'rating', 4, 3 );

例4: コメントの既存メタデータを削除して新しい値に置き換える

update_comment_meta( get_comment_ID(), 'rating', null );
update_comment_meta( get_comment_ID(), 'rating', 5 );

例5: 条件に基づいてコメントのメタデータを変更する

if ( get_comment_meta( get_comment_ID(), 'rating', true ) < 3 ) {
    update_comment_meta( get_comment_ID(), 'rating', 3 );
}

注意事項

• 存在しないコメントIDを指定すると、何も更新されません。
• $meta_valueが空の場合、該当するメタデータは削除されます。
• 大量のコメントに対して使用する際は、パフォーマンスへの影響に注意してください。