1. 首页
  2. WordPress 函数手册

delete_user_meta()

delete_user_meta( int $user_id, string $meta_key, mixed $meta_value =  )

从用户中删除元数据匹配条件。
Remove metadata matching criteria from a user.

目录锚点:#说明#参数#返回#源码#笔记


说明(Description)

可以基于键或键和值进行匹配。基于键和值进行删除将避免删除具有相同键的重复元数据。如果需要,它还允许删除所有元数据匹配键。


参数(Parameters)

参数 类型 必填 说明
$user_id (int) 必需 用户ID
$meta_key (string) 必需 元数据名称。
$meta_value (mixed) 可选 元数据值。

返回(Return)

(bool)成功时正确,失败时错误。


源码(Source)

/**
 * Remove metadata matching criteria from a user.
 *
 * 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 3.0.0
 * @link https://codex.wordpress.org/Function_Reference/delete_user_meta
 *
 * @param int    $user_id    User ID
 * @param string $meta_key   Metadata name.
 * @param mixed  $meta_value Optional. Metadata value.
 * @return bool True on success, false on failure.
 */
function delete_user_meta($user_id, $meta_key, $meta_value = '') {
	return delete_metadata('user', $user_id, $meta_key, $meta_value);
}
更新版本 源码位置 使用 被使用
3.0.0 wp-includes/user.php:812 4 1 function

笔记(Notes)

基本示例

delete_user_meta() 为WP2原创文章,链接:https://www.wp2.cn/functions/delete_user_meta/

发表评论

您的电子邮箱地址不会被公开。