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. If provided, rows will only be removed that match the value. Must be serializable if non-scalar.

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 );
}

Uses

Uses Description
wp-includes/meta.php: delete_metadata()

Deletes metadata for the specified object.

Used By

Used By Description
wp-includes/class-wp-user-meta-session-tokens.php: WP_User_Meta_Session_Tokens::update_sessions()

Updates the user’s sessions in the usermeta table.
wp-includes/user.php: send_confirmation_on_profile_email()

Send a confirmation request email when a change of user email address is attempted.
wp-includes/class-wp-user.php: WP_User::remove_all_caps()

Remove all of the capabilities of the user.
wp-includes/user.php: delete_user_option()

Delete user option with global blog capability.

Changelog

Version Description
3.0.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/delete_user_meta