add_comment_meta()


WordPressのadd_comment_meta()関数は、指定されたコメントにメタデータを追加するために使用されます。メタデータは、コメントに関連する追加情報を保存するために利用されます。

構文

add_comment_meta( int $comment_id, string $meta_key, mixed $meta_value, bool $unique = false );

引数の説明:

  • $comment_id(int) — メタデータを追加するコメントのID。
  • $meta_key(string) — 追加するメタデータのキー。
  • $meta_value(mixed) — 追加するメタデータの値。
  • $unique(bool) — 同じキーのメタデータが既に存在する場合に、新しいメタデータを追加しないようにするかどうか。デフォルトはfalse。

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

この例では、コメントIDが5のコメントに「rating」というキーでメタデータを追加します。

add_comment_meta( 5, 'rating', 4 );

例2: ユニークなメタデータを追加する

この例では、同じキーのメタデータが既に存在する場合に新しいメタデータを追加しないようにします。

add_comment_meta( 5, 'rating', 4, true );

例3: 動的にコメントIDを取得してメタデータを追加する

この例では、現在のコメントのIDを取得し、そのコメントにメタデータを追加します。

$comment_id = get_comment_ID(); add_comment_meta( $comment_id, 'user_ip', $_SERVER['REMOTE_ADDR'] );

例4: 配列をメタデータとして追加する

この例では、配列をメタデータとして追加します。

add_comment_meta( 5, 'preferences', array( 'theme' => 'dark', 'font_size' => 'large' ) );

例5: メタデータの存在を確認してから追加する

この例では、メタデータが既に存在しない場合にのみ追加します。

if ( ! get_comment_meta( 5, 'rating', true ) ) { add_comment_meta( 5, 'rating', 4 ); }

例6: 複数のメタデータを一度に追加する

この例では、複数のメタデータを一度に追加します。

add_comment_meta( 5, 'rating', 4 ); add_comment_meta( 5, 'review', 'Great product!' );

例7: メタデータを追加した後にアクションを実行する

この例では、メタデータを追加した後に特定のアクションを実行します。

add_comment_meta( 5, 'rating', 4 ); do_action( 'comment_meta_added', 5, 'rating', 4 );

例8: メタデータを追加する前にフィルタリングする

この例では、メタデータを追加する前にフィルタリングを行います。

$meta_value = apply_filters( 'pre_add_comment_meta', '4', 5, 'rating' ); add_comment_meta( 5, 'rating', $meta_value );

注意点

  • メタデータのキーは一意である必要がありますが、$uniqueをfalseに設定することで同じキーで複数のメタデータを追加できます。
  • メタデータの値はシリアライズ可能なデータ型である必要があります。
  • コメントIDが存在しない場合、関数はfalseを返します。

関連機能：