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

Adds meta data field to a comment.

Parameters

$comment_idintrequired

Comment ID.

$meta_keystringrequired

Metadata name.

$meta_valuemixedrequired

Metadata value. Arrays and objects are stored as serialized data and will be returned as the same type when retrieved. Other data types will be stored as strings in the database:

false is stored and retrieved as an empty string ('')
true is stored and retrieved as '1'
numbers (both integer and float) are stored and retrieved as strings Must be serializable if non-scalar.

$uniquebooloptional

Whether the same key should not be added.

Default:false

Return

int|false Meta ID on success, false on failure.

Source

function add_comment_meta( $comment_id, $meta_key, $meta_value, $unique = false ) {
	return add_metadata( 'comment', $comment_id, $meta_key, $meta_value, $unique );
}

View all references View on Trac View on GitHub

Uses	Description
add_metadata()`wp-includes/meta.php`	Adds metadata for the specified object.

Used by	Description
wp_spam_comment()`wp-includes/comment.php`	Marks a comment as Spam.
wp_insert_comment()`wp-includes/comment.php`	Inserts a comment into the database.
wp_trash_comment()`wp-includes/comment.php`	Moves a comment to the Trash

Changelog

Version	Description
2.9.0	Introduced.

User Contributed Notes

Skip to note 3 content

Hitesh Patel 1 year ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

// Adding comment meta data
$comment_id = 123;
$meta_key = ‘user_rating’;
$meta_value = 5;

add_comment_meta( $comment_id, $meta_key, $meta_value );

$comment_id: The ID of the comment you want to attach the metadata to.
$meta_key: A unique key that identifies the type of metadata you are storing.
$meta_value: The value associated with the metadata. In this case, a numeric rating of 5.

This will add a custom field named user_rating with the value 5 to the comment with ID 123.

Log in to add feedback
Skip to note 4 content

Codex 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -6You must log in to vote on the helpfulness of this note
Basic Example

Add a custom posted value to every new comment
```
<?php
function add_custom_comment_field( $comment_id ) {

   add_comment_meta( $comment_id, 'my_custom_comment_field', $_POST['my_custom_comment_field'] );
}
add_action( 'comment_post', 'add_custom_comment_field' );
?>
```
Log in to add feedback

You must log in before being able to contribute a note or feedback.