wp_user_settings

Saves and restores user interface settings stored in a cookie.

Description

wp_user_settings(); 

Checks if the current user-settings cookie is updated and stores it. When no cookie exists (different browser used), adds the last saved cookie restoring the settings.

Usage

  1. if ( !function_exists( 'wp_user_settings' ) ) { 
  2.     require_once ABSPATH . WPINC . '/option.php'; 
  3. } 
  4.  
  5.   
  6. // NOTICE! Understand what this does before running. 
  7. $result = wp_user_settings(); 
  8.     

Defined (1)

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

/wp-includes/option.php  
  1. function wp_user_settings() { 
  2.  
  3.     if ( ! is_admin() || wp_doing_ajax() ) { 
  4.         return; 
  5.     } 
  6.  
  7.     if ( ! $user_id = get_current_user_id() ) { 
  8.         return; 
  9.     } 
  10.  
  12.         return; 
  13.     } 
  14.  
  15.     $settings = (string) get_user_option( 'user-settings', $user_id ); 
  16.  
  17.     if ( isset( $_COOKIE['wp-settings-' . $user_id] ) ) { 
  18.         $cookie = preg_replace( '/[^A-Za-z0-9=&_]/', '', $_COOKIE['wp-settings-' . $user_id] ); 
  19.  
  20.         // No change or both empty 
  21.         if ( $cookie == $settings ) 
  22.             return; 
  23.  
  24.         $last_saved = (int) get_user_option( 'user-settings-time', $user_id ); 
  25.         $current = isset( $_COOKIE['wp-settings-time-' . $user_id]) ? preg_replace( '/[^0-9]/', '', $_COOKIE['wp-settings-time-' . $user_id] ) : 0; 
  26.  
  27.         // The cookie is newer than the saved value. Update the user_option and leave the cookie as-is 
  28.         if ( $current > $last_saved ) { 
  29.             update_user_option( $user_id, 'user-settings', $cookie, false ); 
  30.             update_user_option( $user_id, 'user-settings-time', time() - 5, false ); 
  31.             return; 
  32.         } 
  33.     } 
  34.  
  35.     // The cookie is not set in the current browser or the saved value is newer. 
  36.     $secure = ( 'https' === parse_url( admin_url(), PHP_URL_SCHEME ) ); 
  37.     setcookie( 'wp-settings-' . $user_id, $settings, time() + YEAR_IN_SECONDS, SITECOOKIEPATH, null, $secure ); 
  38.     setcookie( 'wp-settings-time-' . $user_id, time(), time() + YEAR_IN_SECONDS, SITECOOKIEPATH, null, $secure ); 
  39.     $_COOKIE['wp-settings-' . $user_id] = $settings; 
  40. }