delete_comment_meta()删除一个评论的meta自定义附加信息

目录

描述

Remove metadata matching criteria from a comment. You can match based on the key, or key and value. Removing based on key and value will keep from removing duplicate metadata with the same key. It also allows removing all metadata matching key, if needed.

delete_comment_meta() allows you to delete any meta values stored against comments, which have been set using add_comment_meta(). Similar method to delete_post_meta().

delete_comment_meta() 描述

用法

<?php delete_comment_meta$comment_id$meta_key$meta_value ); ?>

delete_comment_meta() 用法

参数

$comment_id

(integer) (必填) Comment ID

默认值: None

$meta_key

(string) (必填) Metadata key

默认值: None

$meta_value

(mixed) (可选) Metadata value

默认值: Empty string

delete_comment_meta() 参数

返回值

(boolean

False for failure. True for success.

delete_comment_meta() 返回值

示例

/* ----------------------------------
 * wordpress之魂 © http://wphun.com
 * ---------------------------------- */

<?php

// Delete all metadata with the key 'my_meta_key' for comment ID 5.
delete_comment_meta( 5, 'my_meta_key' );

// Delete metadata for 'my_meta_key' only where the meta_value is 'foo'.
delete_comment_meta( 5, 'my_meta_key', 'foo' );

?>

delete_comment_meta() 示例

注意

历史

添加于 版本: 2.9.0

delete_comment_meta() 历史

源文件

delete_comment_meta() 函数的代码位于 wp-includes/comment.php

/* ----------------------------------
 * wordpress之魂 © http://wphun.com
 * ---------------------------------- */
/**
 * Remove metadata matching criteria from a comment.
 *
 * You can match based on the key, or key and value. Removing based on key and
 * value, will keep from removing duplicate metadata with the same key. It also
 * allows removing all metadata matching key, if needed.
 *
 * @since 2.9.0
 * @link https://codex.wordpress.org/Function_Reference/delete_comment_meta
 *
 * @param int $comment_id comment ID
 * @param string $meta_key Metadata name.
 * @param mixed $meta_value Optional. Metadata value.
 * @return bool True on success, false on failure.
 */
function delete_comment_meta($comment_id, $meta_key, $meta_value = '') {
	return delete_metadata('comment', $comment_id, $meta_key, $meta_value);
}

delete_comment_meta() 源文件