Codex

Function Reference/delete usermeta

Contents

Description

Removes a user meta record from the wp_usermeta database table for a specific user ID.

Usage

 <?php delete_usermeta( $user_id, $meta_key, $meta_value ); ?> 

Parameters

$user_id
(integer) (required) The ID of the WordPress user
Default: None
$meta_key
(string) (required) The meta_key field value
Default: None
$meta_value
(string) (optional) The meta_value field value; if omitted, the key is deleted regardless of value
Default: None

Return Values

(bool) 
  • True if deletion completed.
  • False if user_id is not a number.

Example

<?php if (delete_usermeta(7, 'first_name')) {
    echo 'User meta key successfully removed!';
} else {
    echo 'User meta record could not be removed!';
} ?> 

Change Log

Since: 2.0.0

Source File

delete_usermeta() is located in wp-includes/user.php.

Related

get_usermeta(), update_usermeta(), delete_usermeta()

See also index of Function Reference and index of Template Tags.
Retrieved from "http://codex.wordpress.org/Function_Reference/delete_usermeta"

Codex Resources