delete_user_setting

Delete user interface settings.

Description

(bool|null) delete_user_setting( (string) $names );

Deleting settings would reset them to the defaults.

This function has to be used before any output has started as it calls setcookie(…).

Returns (bool|null)

True if deleted successfully, false if not. Null if the current user can't be established.

Parameters (1)

0. $names (string): The name or array of names of the setting to be deleted.

Usage

if ( !function_exists( 'delete_user_setting' ) ) { 
    require_once ABSPATH . WPINC . '/option.php'; 
} 
  
// The name or array of names of the setting to be deleted. 
$names = ''; 
  
// NOTICE! Understand what this does before running. 
$result = delete_user_setting($names);

Defined (1)

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

/wp-includes/option.php

function delete_user_setting( $names ) { 
    if ( headers_sent() ) { 
        return false; 
    } 
 
    $all_user_settings = get_all_user_settings(); 
    $names = (array) $names; 
    $deleted = false; 
 
    foreach ( $names as $name ) { 
        if ( isset( $all_user_settings[$name] ) ) { 
            unset( $all_user_settings[$name] ); 
            $deleted = true; 
        } 
    } 
 
    if ( $deleted ) { 
        return wp_set_all_user_settings( $all_user_settings ); 
    } 
 
    return false; 
}