get_user_setting( string $name, string|false $default_value = false ): mixed
- Since
- 2.7.0
- Source
wp-includes/option.php:1754
Compatibility
- WordPress
- since 2.7.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$namestring- The name of the setting.
$default_valuestring|falseoptional- Default value to return when $name is not set. Default false.Default:
false
Return value
mixed- The last saved user setting or the default value/false if it doesn't exist.
Performance profile
How much work a call to get_user_setting() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 8–9
- Plugin surface
- None
- Called by
- 20
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 10.
Nothing here hands control to plugin code.
20 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_user_setting() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 8–9 | get_all_user_settings() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 10 instructions, 8–9 executed per call, 1 branch. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
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()
- 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.
Show all 20
- image_link_input_fields()Retrieves HTML for the Link URL buttons with the default link type as specified.
- image_size_input_fields()Retrieves HTML for the size radio buttons with the specified one checked.
- media_upload_gallery_form()Adds gallery form to upload iframe.
- media_upload_library_form()Outputs the legacy media upload form for the media library.
- media_upload_max_image_resize()Displays the checkbox to scale images.
- media_upload_type_form()Outputs the legacy media upload form for a given media type.
- media_upload_type_url_form()Outputs the legacy media upload form for external media.
- wp_default_editor()Finds out which editor should be displayed by default.
Source code
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;}Changelog
Introduced in 2.7.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.8.8 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.