delete_user_meta()
云策文档标注
概述
delete_user_meta() 函数用于从指定用户中删除匹配条件的元数据。它基于用户ID、元数据键和可选值来移除数据，支持防止重复删除。
关键要点
- 函数基于用户ID和元数据键删除元数据，可选元数据值用于精确匹配。
- 出于历史原因，输入时元数据键和值需要“转义斜杠”。
- 返回布尔值：成功为 true，失败为 false。
- 内部调用 delete_metadata() 函数实现功能。
代码示例
function delete_user_meta( $user_id, $meta_key, $meta_value = '' ) {
return delete_metadata( 'user', $user_id, $meta_key, $meta_value );
}
原文内容
Removes metadata matching criteria from a user.
Description
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.
For historical reasons both the meta key and the meta value are expected to be “slashed” (slashes escaped) on input.
Parameters
$user_idintrequired-
User ID
$meta_keystringrequired-
Metadata name.
$meta_valuemixedoptional-
Metadata value. If provided, rows will only be removed that match the value.
Must be serializable if non-scalar. Default empty.
Source
function delete_user_meta( $user_id, $meta_key, $meta_value = '' ) {
return delete_metadata( 'user', $user_id, $meta_key, $meta_value );
}
Changelog
| Version | Description |
|---|---|
| 3.0.0 | Introduced. |
Skip to note 2 content
Codex
Basic Example