get_user_option() – Function | Developer.WordPress.org

Retrieves user option that can be either per Site or per Network.

Description

If the user ID is not given, then the current user will be used instead. If the user ID is given, then the user data will be retrieved. The filter for the result, will also pass the original option name and finally the user data object as the third parameter.

The option will first check for the per site name and then the per Network name.

Parameters

$optionstringrequired: User option name.
$userintoptional: User ID.
$deprecatedstringoptional: Use get_option() to check for an option in the options table.
Default:''

Return

mixed User option value on success, false on failure.

More Information

Usage:

get_user_option( $option, $user );

Source

function get_user_option( $option, $user = 0, $deprecated = '' ) {
	global $wpdb;

	if ( ! empty( $deprecated ) ) {
		_deprecated_argument( __FUNCTION__, '3.0.0' );
	}

	if ( empty( $user ) ) {
		$user = get_current_user_id();
	}

	$user = get_userdata( $user );
	if ( ! $user ) {
		return false;
	}

	$prefix = $wpdb->get_blog_prefix();
	if ( $user->has_prop( $prefix . $option ) ) { // Blog-specific.
		$result = $user->get( $prefix . $option );
	} elseif ( $user->has_prop( $option ) ) { // User-specific and cross-blog.
		$result = $user->get( $option );
	} else {
		$result = false;
	}

	/**
	 * Filters a specific user option value.
	 *
	 * The dynamic portion of the hook name, `$option`, refers to the user option name.
	 *
	 * @since 2.5.0
	 *
	 * @param mixed   $result Value for the user's option.
	 * @param string  $option Name of the option being retrieved.
	 * @param WP_User $user   WP_User object of the user whose option is being retrieved.
	 */
	return apply_filters( "get_user_option_{$option}", $result, $option, $user );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( “get_user_option_{$option}”, mixed $result, string $option, WP_User $user ): Filters a specific user option value.

Uses	Description
wpdb::get_blog_prefix()`wp-includes/class-wpdb.php`	Gets blog prefix.
get_userdata()`wp-includes/pluggable.php`	Retrieves user info by user ID.
_deprecated_argument()`wp-includes/functions.php`	Marks a function argument as deprecated and inform when it has been used.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.
get_current_user_id()`wp-includes/user.php`	Gets the current user’s ID.

Show 3 more Show less

Used by	Description
wp_localize_community_events()`wp-includes/script-loader.php`	Localizes community events data that needs to be passed to dashboard.js.
wp_ajax_get_community_events()`wp-admin/includes/ajax-actions.php`	Handles Ajax requests for community events
wp_edit_attachments_query_vars()`wp-admin/includes/post.php`	Returns the query variables for the current attachments request.
WP_Screen::render_per_page_options()`wp-admin/includes/class-wp-screen.php`	Renders the items per page option.
WP_Screen::render_screen_meta()`wp-admin/includes/class-wp-screen.php`	Renders the screen’s help section.
get_hidden_columns()`wp-admin/includes/screen.php`	Get a list of hidden columns.
get_hidden_meta_boxes()`wp-admin/includes/screen.php`	Gets an array of IDs of hidden meta boxes.
WP_List_Table::get_items_per_page()`wp-admin/includes/class-wp-list-table.php`	Gets the number of items to display on a single page.
admin_color_scheme_picker()`wp-admin/includes/misc.php`	Displays the default admin color scheme picker (Used in user-edit.php).
wp_color_scheme_settings()`wp-admin/includes/misc.php`
install_plugins_favorites_form()`wp-admin/includes/plugin-install.php`	Shows a username form for the favorites page.
display_plugins_table()`wp-admin/includes/plugin-install.php`	Displays plugin content based on plugin list.
wp_dashboard_quick_press()`wp-admin/includes/dashboard.php`	Displays the Quick Draft widget.
default_password_nag_handler()`wp-admin/includes/user.php`
default_password_nag_edit_user()`wp-admin/includes/user.php`
default_password_nag()`wp-admin/includes/user.php`
WP_Plugin_Install_List_Table::prepare_items()`wp-admin/includes/class-wp-plugin-install-list-table.php`
do_meta_boxes()`wp-admin/includes/template.php`	Meta-Box template function.
wp_edit_posts_query()`wp-admin/includes/post.php`	Runs the query to fetch the posts for listing on the edit posts page.
postbox_classes()`wp-admin/includes/post.php`	Returns the list of classes to be used by a meta box.
wp_ajax_query_themes()`wp-admin/includes/ajax-actions.php`	Handles getting themes from themes_api() via AJAX.
wp_nav_menu_setup()`wp-admin/includes/nav-menu.php`	Register nav menu meta boxes and advanced menu items.
wp_initial_nav_menu_meta_boxes()`wp-admin/includes/nav-menu.php`	Limit the amount of meta boxes to pages, posts, links, and categories for first time users.
enqueue_comment_hotkeys_js()`wp-admin/includes/comment.php`	Enqueues comment shortcuts jQuery script.
auth_redirect()`wp-includes/pluggable.php`	Checks if a user is logged in, if not it redirects them to the login page.
user_can_richedit()`wp-includes/general-template.php`	Determines whether the user can access the visual editor.
_get_admin_bar_pref()`wp-includes/admin-bar.php`	Retrieves the admin bar display preference of a user.
wp_user_settings()`wp-includes/option.php`	Saves and restores user interface settings stored in a cookie.
get_all_user_settings()`wp-includes/option.php`	Retrieves all user interface settings.
wp_style_loader_src()`wp-includes/script-loader.php`	Administration Screen CSS for changing the styles.

Show 25 more Show less

Changelog

Version	Description
2.0.0	Introduced.

User Contributed Notes

Skip to note 2 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
Basic Example
```
$bar = get_user_option( 'show_admin_bar_front', get_current_user_id() );

if (  $bar == 'true' ) {
	echo 'The admin bar is enabled';
} else {
	echo 'The admin bar is disabled';
}
```
Log in to add feedback

get_user_option( string $option, int $user, string $deprecated = '' ): mixed

In this article