delete_user_meta( int $user_id, string $meta_key, mixed $meta_value = '' )
Remove metadata matching criteria from a user.
Description 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 Parameters
- $user_id
-
(int) (Required) User ID
- $meta_key
-
(string) (Required) Metadata name.
- $meta_value
-
(mixed) (Optional) Metadata value.
Default value: ''
Return Return
(bool) True on success, false on failure.
Source 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 );
}
Expand full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 3.0.0 | Introduced. |
User Contributed Notes User Contributed Notes
You must log in before being able to contribute a note or feedback.
Basic Example
<?php if ( ! delete_user_meta($user_id, '_province') ) { echo "Ooops! Error while deleting this information!"; } ?>