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.
Parameters
$user_id
intrequired- User ID
$meta_key
stringrequired- Metadata name.
$meta_value
mixedoptional- Metadata value. If provided, rows will only be removed that match the value.
Must be serializable if non-scalar.Default:
''
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. |
Basic Example