update_comment_meta( int $comment_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' )
Update 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.
- $prev_value
-
(mixed) (Optional) Previous value to check before removing.
Default value: ''
Return
(int|bool) Meta ID if the key didn't exist, true on successful update, false on failure.
Source
File: wp-includes/comment.php
function update_comment_meta($comment_id, $meta_key, $meta_value, $prev_value = '') {
$updated = update_metadata( 'comment', $comment_id, $meta_key, $meta_value, $prev_value );
if ( $updated ) {
wp_cache_set( 'last_changed', microtime(), 'comment' );
}
return $updated;
}
Changelog
| Version | Description |
|---|---|
| WP-2.9.0 | Introduced. |