add_comment_meta( int $comment_id, string $meta_key, mixed $meta_value, bool $unique = false )
Add meta data field to a comment.
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 value: false
Return
(int|false) Meta ID on success, false on failure.
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 ); }
Changelog
Version | Description |
---|---|
2.9.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/add_comment_meta