概要
add_comment_meta関数は、WordPressのコメントに対してメタ情報の値を追加するために使用されます。この関数は、カスタムデータをコメントに関連付けることができ、さまざまな機能を実装する際に役立ちます。以下は、add_comment_meta関数がよく使われる場面の例です。
- コメントに追加情報を記録する
- コメントに対する評価やスコアを保存する
- ユーザーがコメントに対して特定のフラグを設定する
- コメントの状態をトラッキングする（承認済み、スパムなど）
- コメントに関連する画像のURLを保存する
- コメントの返信に必要な情報を保存する
- コメントを特定のカテゴリーやタグに分類する
- 読者の行動に基づいたデータを保存する
構文
add_comment_meta( $comment_id, $meta_key, $meta_value, $unique );
パラメータ
$comment_id: メタ情報を追加する対象のコメントのID（整数）。$meta_key: メタ情報のキー（文字列）。$meta_value: メタ情報の値（任意の型）。$unique: （任意）このメタキーがユニークである必要がある場合はtrue（ブール値）。
戻り値
true もしメタ情報が正常に追加された場合、それ以外の場合は false。
関連する関数
使用可能なバージョン
WordPress 2.9.0 以降で使用可能です。
コアファイルのパス
wp-includes/meta.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
$meta_key = 'user_rating';
$meta_value = '5'; // ユーザーが与えた評価
add_comment_meta( $comment_id, $meta_key, $meta_value );
この例では、コメントID 1のコメントに「user_rating」というメタ情報を追加し、その値を「5」に設定しています。
サンプル2: ユニークなメタ情報の追加
$comment_id = 2; // コメントID
$meta_key = 'user_feedback';
$meta_value = 'Great post!';
$unique = true; // ユニークなメタ情報
add_comment_meta( $comment_id, $meta_key, $meta_value, $unique );
ここでは、コメントID 2に対して「user_feedback」というユニークなメタ情報を追加しています。この場合、同じキーで再度追加することはできません。
サンプル3: 画像URLのメタ情報の追加
$comment_id = 3; // コメントID
$meta_key = 'image_url';
$meta_value = 'http://example.com/image.jpg';
add_comment_meta( $comment_id, $meta_key, $meta_value );
このコードは、コメントID 3に画像のURL情報をメタ情報として追加します。
サンプル4: 評価データの追加
$comment_id = 4; // コメントID
$meta_key = 'review_score';
$meta_value = '4.2';
add_comment_meta( $comment_id, $meta_key, $meta_value );
コメントID 4のコメントに「review_score」というメタ情報を追加し、その値を「4.2」に設定しています。
サンプル5: コメントのステータス情報の追加
$comment_id = 5; // コメントID
$meta_key = 'comment_status';
$meta_value = 'approved'; // 承認済み
add_comment_meta( $comment_id, $meta_key, $meta_value );
この例では、コメントID 5の「comment_status」というメタ情報に「approved」の値を追加しています。