概要
update_comment_meta 関数は、WordPressのコメントに関連するメタデータ（追加情報）を追加または更新するために使用されます。この関数は、コメントに対してカスタム情報を保存する際に役立ち、特に特定の機能やプラグインでの利用が一般的です。以下は、この関数がよく使われる場面の例です。
- コメントに製品レビューや評価を追加する
- ユーザーがコメントに書いた特定のメモやフラグを保存する
- スパムコメントのフラグを管理する
- コメントのメタ情報に関連する統計データを保存する
- 特定のユーザーからのコメントの信頼性を評価する
- コメントに返信の数を追跡する
- コメントの編集履歴や変更ログを保存する
- カスタムフィールドを利用した特定の業務ロジックを実装する
構文
update_comment_meta( $comment_id, $meta_key, $meta_value, $prev_value );
パラメータ
$comment_id(int) : 更新するコメントのID。$meta_key(string) : メタデータのキー（名前）。$meta_value: メタデータの値。$prev_value: （オプション）更新前のメタデータの値。指定した場合、この値と一致するメタデータのみが更新されます。
戻り値
- 成功した場合は
true、失敗した場合はfalseを返します。
関連する関数
使用可能なバージョン
この関数はWordPressのバージョン 2.9.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 |
非推奨または削除されたバージョン
現在のところ、特定のバージョンで update_comment_meta 関数が非推奨または削除されたという情報はありません。
サンプルコード
サンプルコード1: コメントメタ情報を追加する
$comment_id = 123; // コメントのID
$meta_key = 'rating';
$meta_value = '5';
update_comment_meta( $comment_id, $meta_key, $meta_value );
このコードは、コメントID123に対して「rating」というメタ情報を追加し、その値を5に設定します。
サンプルコード2: 既存のメタ情報を更新する
$comment_id = 123; // コメントのID
$meta_key = 'reviews';
$meta_value = 'Great product!';
update_comment_meta( $comment_id, $meta_key, $meta_value );
このコードは、コメントID123に対して「reviews」というメタ情報を更新し、その内容を「Great product!」にします。
サンプルコード3: 特定のメタ情報を条件付きで更新する
$comment_id = 123; // コメントのID
$meta_key = 'votes';
$meta_value = '10';
$prev_value = '5';
update_comment_meta( $comment_id, $meta_key, $meta_value, $prev_value );
このコードは、「votes」というメタ情報が5のときにのみ、その値を10に更新します。
サンプルコード4: メタ情報の削除
$comment_id = 123; // コメントのID
$meta_key = 'unneeded_meta';
delete_comment_meta( $comment_id, $meta_key );
該当するメタ情報を削除する場合は delete_comment_meta を使用します。
サンプルコード5: メタ情報の確認
$comment_id = 123; // コメントのID
$meta_key = 'status';
$status = get_comment_meta( $comment_id, $meta_key, true );
if ($status === 'approved') {
// 承認されたコメントの処理
}
このコードは、コメントID123の「status」メタ情報を取得し、その値が「approved」であれば特定の処理を実行します。