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

Description

Parameters

$namestring

The name of the setting.

$valuestring

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.

Uses · 2

• get_all_user_settings()Retrieves all user interface settings.
• wp_set_all_user_settings()Private. Sets all user interface settings.

Used by · 4

• WP_Comments_List_Table::prepare_items()
• WP_MS_Sites_List_Table::prepare_items()Prepares the list of sites for display.
• WP_MS_Users_List_Table::prepare_items()
• WP_Posts_List_Table::prepare_items()

Source

View on Trac ↗View on GitHub ↗

1774function set_user_setting( $name, $value ) {1775	if ( headers_sent() ) {1776		return false;1777	}1778 1779	$all_user_settings          = get_all_user_settings();1780	$all_user_settings[ $name ] = $value;1781 1782	return wp_set_all_user_settings( $all_user_settings );1783}

History

Introduced in 2.8.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/option.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.