wp_set_all_user_settings

Private.

Description

(bool|null) wp_set_all_user_settings( (array) $user_settings );

Set all user interface settings.

Returns (bool|null)

False if the current user can't be found, null if the current user is not a super admin or a member of the site, otherwise true.

Parameters (1)

0. $user_settings (array): The user settings.

Usage

if ( !function_exists( 'wp_set_all_user_settings' ) ) { 
    require_once ABSPATH . WPINC . '/option.php'; 
} 
  
// The user settings. 
$user_settings = array(); 
  
// NOTICE! Understand what this does before running. 
$result = wp_set_all_user_settings($user_settings);

Defined (1)

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

/wp-includes/option.php

function wp_set_all_user_settings( $user_settings ) { 
    global $_updated_user_settings; 
 
    if ( ! $user_id = get_current_user_id() ) { 
        return false; 
    } 
 
    if ( is_super_admin() && ! is_user_member_of_blog() ) { 
        return; 
    } 
 
    $settings = ''; 
    foreach ( $user_settings as $name => $value ) { 
        $_name = preg_replace( '/[^A-Za-z0-9_-]+/', '', $name ); 
        $_value = preg_replace( '/[^A-Za-z0-9_-]+/', '', $value ); 
 
        if ( ! empty( $_name ) ) { 
            $settings .= $_name . '=' . $_value . '&'; 
        } 
    } 
 
    $settings = rtrim( $settings, '&' ); 
    parse_str( $settings, $_updated_user_settings ); 
 
    update_user_option( $user_id, 'user-settings', $settings, false ); 
    update_user_option( $user_id, 'user-settings-time', time(), false ); 
 
    return true; 
}