A WordPress-centric search engine for devs and theme authors



set_user_setting ›

Since2.8.0
Deprecatedn/a
set_user_setting ( $name, $value )
Parameters: (2)
  • (string) $name The name of the setting.
    Required: Yes
  • (string) $value The value for the setting.
    Required: Yes
Returns:
  • (bool|null) True if set successfully, false otherwise. Null if the current user is not a member of the site.
Defined at:
Codex:

Adds or updates user interface setting.

Both $name and $value can contain only ASCII letters, numbers, hyphens, and underscores. This function has to be used before any output has started as it calls setcookie().


Source

function set_user_setting( $name, $value ) {
	if ( headers_sent() ) {
		return false;
	}

	$all_user_settings          = get_all_user_settings();
	$all_user_settings[ $name ] = $value;

	return wp_set_all_user_settings( $all_user_settings );
}