delete_user_meta( int $user_id, string $meta_key, mixed $meta_value = '' )
Remove 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.
Parameters
- $user_id
-
(int) (Required) User ID
- $meta_key
-
(string) (Required) Metadata name.
- $meta_value
-
(mixed) (Optional) Metadata value.
Default value: ''
Return
(bool) True on success, false on failure.
Source
File: wp-includes/user.php
function delete_user_meta($user_id, $meta_key, $meta_value = '') {
return delete_metadata('user', $user_id, $meta_key, $meta_value);
}
Changelog
| Version | Description |
|---|---|
| WP-3.0.0 | Introduced. |