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



add_comment_meta › WordPress Function

Since2.9.0
Deprecatedn/a
› add_comment_meta ( $comment_id, $meta_key, $meta_value, $unique = false )
Parameters: (4)
  • (int) $comment_id Comment ID.
    Required: Yes
  • (string) $meta_key Metadata name.
    Required: Yes
  • (mixed) $meta_value Metadata value. Arrays and objects are stored as serialized data and will be returned as the same type when retrieved. Other data types will be stored as strings in the database: - false is stored and retrieved as an empty string ('') - true is stored and retrieved as '1' - numbers (both integer and float) are stored and retrieved as strings Must be serializable if non-scalar.
    Required: Yes
  • (bool) $unique Optional. Whether the same key should not be added. Default false.
    Required: No
    Default: false
Links:
Returns:
  • (int|false) Meta ID on success, false on failure.
Defined at:
Codex:

Adds meta data field to a comment.

For historical reasons both the meta key and the meta value are expected to be "slashed" (slashes escaped) on input.


Related Functions: get_comment_meta, update_comment_meta, delete_comment_meta, add_comments_page, add_post_meta

Source 

function add_comment_meta( $comment_id, $meta_key, $meta_value, $unique = false ) {
	return add_metadata( 'comment', $comment_id, $meta_key, $meta_value, $unique );
}