delete_user_setting

The timeline below displays how wordpress function delete_user_setting has changed across different WordPress versions. If a version is not listed, refer to the next available version below.

WordPress Version: 6.1

/**
 * Deletes user interface settings.
 *
 * Deleting settings would reset them to the defaults.
 *
 * This function has to be used before any output has started as it calls `setcookie()`.
 *
 * @since 2.7.0
 *
 * @param string $names The name or array of names of the setting to be deleted.
 * @return bool|null True if deleted successfully, false otherwise.
 *                   Null if the current user is not a member of the site.
 */
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;
}

WordPress Version: 5.5

/**
 * Deletes user interface settings.
 *
 * Deleting settings would reset them to the defaults.
 *
 * This function has to be used before any output has started as it calls setcookie().
 *
 * @since 2.7.0
 *
 * @param string $names The name or array of names of the setting to be deleted.
 * @return bool|null True if deleted successfully, false otherwise.
 *                   Null if the current user is not a member of the site.
 */
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;
}

WordPress Version: 5.4

/**
 * Deletes user interface settings.
 *
 * Deleting settings would reset them to the defaults.
 *
 * This function has to be used before any output has started as it calls setcookie().
 *
 * @since 2.7.0
 *
 * @param string $names The name or array of names of the setting to be deleted.
 * @return bool|null True if deleted successfully, false if not. Null if the current user can't be established.
 */
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;
}

WordPress Version: 4.6

/**
 * Delete user interface settings.
 *
 * Deleting settings would reset them to the defaults.
 *
 * This function has to be used before any output has started as it calls setcookie().
 *
 * @since 2.7.0
 *
 * @param string $names The name or array of names of the setting to be deleted.
 * @return bool|null True if deleted successfully, false if not. Null if the current user can't be established.
 */
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;
}

WordPress Version: 4.3

/**
 * Delete user interface settings.
 *
 * Deleting settings would reset them to the defaults.
 * This function has to be used before any output has started as it calls setcookie().
 *
 * @since 2.7.0
 *
 * @param string $names The name or array of names of the setting to be deleted.
 * @return bool|void true if deleted successfully/false if not.
 */
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;
}

WordPress Version: 4.1

/**
 * Delete user interface settings.
 *
 * Deleting settings would reset them to the defaults.
 * This function has to be used before any output has started as it calls setcookie().
 *
 * @since 2.7.0
 *
 * @param string $names The name or array of names of the setting to be deleted.
 * @return null|bool true if deleted successfully/false if not.
 */
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;
}

WordPress Version: 3.9

/**
 * Delete user interface settings.
 *
 * Deleting settings would reset them to the defaults.
 * This function has to be used before any output has started as it calls setcookie().
 *
 * @since 2.7.0
 *
 * @param mixed $names The name or array of names of the setting to be deleted.
 * @return bool true if deleted successfully/false if not.
 */
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;
}

WordPress Version: 3.7

/**
 * Delete user interface settings.
 *
 * Deleting settings would reset them to the defaults.
 * This function has to be used before any output has started as it calls setcookie().
 *
 * @package WordPress
 * @subpackage Option
 * @since 2.7.0
 *
 * @param mixed $names The name or array of names of the setting to be deleted.
 * @return bool true if deleted successfully/false if not.
 */
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;
}