add_comment_meta( int $comment_id, string $meta_key, mixed $meta_value, bool $unique = false )
Add meta data field to a comment.
Description Description
Parameters Parameters
- $comment_id
-
(int) (Required) Comment ID.
- $meta_key
-
(string) (Required) Metadata name.
- $meta_value
-
(mixed) (Required) Metadata value.
- $unique
-
(bool) (Optional) Whether the same key should not be added.
Default value: false
Return Return
(int|bool) Meta ID on success, false on failure.
Source Source
File: wp-includes/comment.php
function add_comment_meta( $comment_id, $meta_key, $meta_value, $unique = false ) {
return add_metadata( 'comment', $comment_id, $meta_key, $meta_value, $unique );
}
Expand full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 2.9.0 | Introduced. |
User Contributed Notes User Contributed Notes
You must log in before being able to contribute a note or feedback.
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' ); ?>