get_user_setting( string $name, string|false $default_value = false ): mixed

Parameters

$namestring

The name of the setting.

$default_valuestring|falseoptional

Default value to return when $name is not set. Default false.Default: false

Return

mixed

The last saved user setting or the default value/false if it doesn't exist.

Uses · 1

• get_all_user_settings()Retrieves all user interface settings.

Used by · 20

• WP_Comments_List_Table::handle_row_actions()Generates and displays row actions links.
• WP_Comments_List_Table::prepare_items()Prepares the comments list items.
• WP_List_Table::get_table_classes()Gets a list of CSS classes for the WP_List_Table table tag.
• WP_List_Table::row_actions()Generates the required HTML for a list of row action links.
• 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()
• WP_Screen::render_view_mode()Renders the list table view mode preferences.
• WP_Screen::show_screen_options()
• _WP_Editors::parse_settings()Parse default arguments for the editor instance.
• default_password_nag_handler()
• image_align_input_fields()Retrieves HTML for the image alignment radio buttons with the specified one checked.

Source

View on Trac ↗View on GitHub ↗

1754function get_user_setting( $name, $default_value = false ) {1755	$all_user_settings = get_all_user_settings();1756 1757	return $all_user_settings[ $name ] ?? $default_value;1758}

History

Introduced in 2.7.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 7.1.0 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.