delete_user_meta( int $user_id, string $meta_key, mixed $meta_value = '' ): bool

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.


Top ↑

Parameters

$user_id int Required
User ID
$meta_key string Required
Metadata name.
$meta_value mixed Optional
Metadata value. If provided, rows will only be removed that match the value.
Must be serializable if non-scalar.

Default: ''


Top ↑

Return

bool True on success, false on failure.


Top ↑

Source

File: wp-includes/user.php. View all references

function delete_user_meta( $user_id, $meta_key, $meta_value = '' ) {
	return delete_metadata( 'user', $user_id, $meta_key, $meta_value );
}


Top ↑

Changelog

Changelog
Version Description
3.0.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.