update_comment_meta() WordPress Function
The update_comment_meta() function is used to update the value of a comment meta field for a given comment.
update_comment_meta( int $comment_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' ) #
Updates comment meta field based on comment ID.
Description
Use the $prev_value parameter to differentiate between meta fields with the same key and comment ID.
If the meta field for the comment does not exist, it will be added.
Parameters
- $comment_id
(int)(Required)Comment ID.
- $meta_key
(string)(Required)Metadata key.
- $meta_value
(mixed)(Required)Metadata value. Must be serializable if non-scalar.
- $prev_value
(mixed)(Optional) Previous value to check before updating. If specified, only update existing metadata entries with this value. Otherwise, update all entries.
Default value: ''
Return
(int|bool) Meta ID if the key didn't exist, true on successful update, false on failure or if the value passed to the function is the same as the one that is already in the database.
Source
File: wp-includes/comment.php
function update_comment_meta( $comment_id, $meta_key, $meta_value, $prev_value = '' ) {
return update_metadata( 'comment', $comment_id, $meta_key, $meta_value, $prev_value );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.9.0 | Introduced. |