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

Adds meta data field to a comment.

Contents

Parameters

$comment_id int Required
Comment ID.
$meta_key string Required
Metadata name.
$meta_value mixed Required
Metadata value. Must be serializable if non-scalar.
$unique bool Optional
Whether the same key should not be added.

Default: false

Top ↑

Return

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

Top ↑

Source

File: wp-includes/comment.php. View all references 

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

View on Trac View on GitHub

Top ↑

Top ↑

Changelog

Changelog
Version Description
2.9.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: -5You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    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' );
?>

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