WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

get_user_setting()

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

In this article

Back to top

Retrieves user interface setting value based on setting name.

Parameters

$namestringrequired
The name of the setting.
$default_valuestring|falseoptional
Default value to return when $name is not set.

Default:false

Return

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

Source

function get_user_setting( $name, $default_value = false ) {
	$all_user_settings = get_all_user_settings();

	return isset( $all_user_settings[ $name ] ) ? $all_user_settings[ $name ] : $default_value;
}

View all references View on Trac View on GitHub

UsesDescription
get_all_user_settings()wp-includes/option.php

Retrieves all user interface settings.

Used byDescription
WP_Screen::render_view_mode()wp-admin/includes/class-wp-screen.php

Renders the list table view mode preferences.

WP_Comments_List_Table::handle_row_actions()wp-admin/includes/class-wp-comments-list-table.php

Generates and displays row actions links.

WP_MS_Users_List_Table::prepare_items()wp-admin/includes/class-wp-ms-users-list-table.php
WP_Screen::show_screen_options()wp-admin/includes/class-wp-screen.php
WP_List_Table::get_table_classes()wp-admin/includes/class-wp-list-table.php

Gets a list of CSS classes for the WP_List_Table table tag.

WP_List_Table::row_actions()wp-admin/includes/class-wp-list-table.php

Generates the required HTML for a list of row action links.

default_password_nag_handler()wp-admin/includes/user.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.

media_upload_type_form()wp-admin/includes/media.php

Outputs the legacy media upload form for a given media type.

media_upload_type_url_form()wp-admin/includes/media.php

Outputs the legacy media upload form for external media.

media_upload_gallery_form()wp-admin/includes/media.php

Adds gallery form to upload iframe.

media_upload_library_form()wp-admin/includes/media.php

Outputs the legacy media upload form for the media library.

media_upload_max_image_resize()wp-admin/includes/media.php

Displays the checkbox to scale images.

image_align_input_fields()wp-admin/includes/media.php

Retrieves HTML for the image alignment radio buttons with the specified one checked.

image_size_input_fields()wp-admin/includes/media.php

Retrieves HTML for the size radio buttons with the specified one checked.

image_link_input_fields()wp-admin/includes/media.php

Retrieves HTML for the Link URL buttons with the default link type as specified.

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
wp_default_editor()wp-includes/general-template.php

Finds out which editor should be displayed by default.

_WP_Editors::parse_settings()wp-includes/class-wp-editor.php

Parse default arguments for the editor instance.

Show 15 moreShow less

Changelog

VersionDescription
2.7.0Introduced.

User Contributed Notes

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