delete_usermeta

Remove user meta data.

Description

delete_usermeta( (int) $user_id, (string) $meta_key, (string) $meta_value = '' );

Parameters (3)

0. $user_id (int): The user id.
1. $meta_key (string): The meta key.
2. $meta_value — Optional. (string) => '': The meta value.

Usage

if ( !function_exists( 'delete_usermeta' ) ) { 
    require_once ABSPATH . WPINC . '/deprecated.php'; 
} 
  
// The user id. 
$user_id = -1; 
  
// The meta key. 
$meta_key = ''; 
  
// The meta value. 
$meta_value = ''; 
  
// NOTICE! Understand what this does before running. 
$result = delete_usermeta($user_id, $meta_key, $meta_value);

Defined (1)

The function is defined in the following location(s).

/wp-includes/deprecated.php

function delete_usermeta( $user_id, $meta_key, $meta_value = '' ) { 
    _deprecated_function( __FUNCTION__, '3.0.0', 'delete_user_meta()' ); 
    global $wpdb; 
    if ( !is_numeric( $user_id ) ) 
        return false; 
    $meta_key = preg_replace('|[^a-z0-9_]|i', '', $meta_key); 
 
    if ( is_array($meta_value) || is_object($meta_value) ) 
        $meta_value = serialize($meta_value); 
    $meta_value = trim( $meta_value ); 
 
    $cur = $wpdb->get_row( $wpdb->prepare("SELECT * FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s", $user_id, $meta_key) ); 
 
    if ( $cur && $cur->umeta_id ) 
        do_action( 'delete_usermeta', $cur->umeta_id, $user_id, $meta_key, $meta_value ); 
 
    if ( ! empty($meta_value) ) 
        $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s AND meta_value = %s", $user_id, $meta_key, $meta_value) ); 
    else 
        $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->usermeta WHERE user_id = %d AND meta_key = %s", $user_id, $meta_key) ); 
 
    clean_user_cache( $user_id ); 
    wp_cache_delete( $user_id, 'user_meta' ); 
 
    if ( $cur && $cur->umeta_id ) 
        do_action( 'deleted_usermeta', $cur->umeta_id, $user_id, $meta_key, $meta_value ); 
 
    return true; 
}