delete_user_meta()
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.
Uses: delete_metadata()
Used By: delete_user_option()
No Hooks.
Return
true|false. True on success, false on failure.
Usage
delete_user_meta( $user_id, $meta_key, $meta_value );
- $user_id(int) (required)
- User ID
- $meta_key(string) (required)
- Metadata name.
- $meta_value(mixed)
- Metadata value. If provided, rows will only be removed that match the value. Must be serializable if non-scalar.
Default: ''
Examples
#1 Delete option _province from user 9:
$user_id = 9;
if ( ! delete_user_meta( $user_id, '_province' ) ) {
echo "Oooops! A mistake happened during this operation!";
}
Changelog
| Since 3.0.0 | Introduced. |
delete_user_meta() delete user meta code WP 6.5.2
function delete_user_meta( $user_id, $meta_key, $meta_value = '' ) {
return delete_metadata( 'user', $user_id, $meta_key, $meta_value );
}