add_comment_meta() WordPress Function
The add_comment_meta() function allows you to add arbitrary data to a comment record. This is useful if you want to store additional data for your own purposes. The first parameter is the comment ID, and the second parameter is the key for the data you're storing. The third parameter is the actual data you're storing. The fourth parameter is a boolean value that determines whether the data should be replaced if it already exists.
add_comment_meta( int $comment_id, string $meta_key, mixed $meta_value, bool $unique = false ) #
Adds 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 ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
2.9.0 | Introduced. |