wpseek.com
A WordPress-centric search engine for devs and theme authors



update_comment_meta › WordPress Function

Since2.9.0
Deprecatedn/a
› update_comment_meta ( $comment_id, $meta_key, $meta_value, $prev_value = '' )
Parameters: (4)
  • (int) $comment_id Comment ID.
    Required: Yes
  • (string) $meta_key Metadata key.
    Required: Yes
  • (mixed) $meta_value Metadata value. Must be serializable if non-scalar.
    Required: Yes
  • (mixed) $prev_value Optional. Previous value to check before updating. If specified, only update existing metadata entries with this value. Otherwise, update all entries. Default empty string.
    Required: No
    Default: (empty)
Links:
Returns:
  • (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.
Defined at:
Codex:

Updates comment meta field based on comment ID.

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. For historical reasons both the meta key and the meta value are expected to be "slashed" (slashes escaped) on input.


Related Functions: delete_comment_meta, update_comment_cache, add_comment_meta, update_post_meta, get_comment_meta

Source 

function update_comment_meta( $comment_id, $meta_key, $meta_value, $prev_value = '' ) {
	return update_metadata( 'comment', $comment_id, $meta_key, $meta_value, $prev_value );
}