WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

set_user_setting()

set_user_setting( string $name, string $value ): bool|null

In this article

Back to top

Adds or updates user interface setting.

Description

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().

Parameters

$namestringrequired
The name of the setting.
$valuestringrequired
The value for the setting.

Return

bool|null True if set successfully, false otherwise.
Null if the current user is not a member of the site.

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 );
}

View all references View on Trac View on GitHub

UsesDescription
get_all_user_settings()wp-includes/option.php

Retrieves all user interface settings.

wp_set_all_user_settings()wp-includes/option.php

Private. Sets all user interface settings.

Used byDescription
WP_MS_Users_List_Table::prepare_items()wp-admin/includes/class-wp-ms-users-list-table.php
WP_MS_Sites_List_Table::prepare_items()wp-admin/includes/class-wp-ms-sites-list-table.php

Prepares the list of sites for display.

WP_Comments_List_Table::prepare_items()wp-admin/includes/class-wp-comments-list-table.php
WP_Posts_List_Table::prepare_items()wp-admin/includes/class-wp-posts-list-table.php

Changelog

VersionDescription
2.8.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Drew Jaynes
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    Override the user setting to always collapse the admin menu for the current user:

    /**
 * Re-set user setting to always collapse the admin menu.
 *
 * @see set_user_setting()
 */
function wpdocs_always_collapse_menu() {
	if ( 'f' != get_user_setting( 'mfold' ) ) {
		set_user_setting( 'mfold', 'f' );
	}
}
add_action( 'admin_head', 'wpdocs_always_collapse_menu' );

You must log in before being able to contribute a note or feedback.