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.

For historical reasons both the meta key and the meta value are expected to be “slashed” (slashes escaped) on input.

Parameters

$user_idintrequired: User ID
$meta_keystringrequired: Metadata name.
$meta_valuemixedoptional: Metadata value. If provided, rows will only be removed that match the value.
Must be serializable if non-scalar. Default empty.

Return

bool True on success, false on failure.

Source

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

View all references View on Trac View on GitHub

Uses	Description
delete_metadata()`wp-includes/meta.php`	Deletes metadata for the specified object.

Used by	Description
WP_User_Meta_Session_Tokens::update_sessions()`wp-includes/class-wp-user-meta-session-tokens.php`	Updates the user’s sessions in the usermeta table.
send_confirmation_on_profile_email()`wp-includes/user.php`	Sends a confirmation request email when a change of user email address is attempted.
WP_User::remove_all_caps()`wp-includes/class-wp-user.php`	Removes all of the capabilities of the user.
delete_user_option()`wp-includes/user.php`	Deletes user option with global blog capability.

Changelog

Version	Description
3.0.0	Introduced.

User Contributed Notes

Skip to note 2 content

Codex 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Basic Example
```
<?php
if ( ! delete_user_meta($user_id, '_province') ) {
  echo "Ooops! Error while deleting this information!";
}
?>
```
Log in to add feedback

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