W3cubDocs

/WordPress

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

Retrieve 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

$option

(string) (Required) User option name.

$user

(int) (Optional) User ID.

$deprecated

(string) (Optional) Use get_option() to check for an option in the options table.

Default value: ''

Return

(mixed) User option value on success, false on failure.

More Information

Usage:
get_user_option( $option, $user );

Source

File: wp-includes/user.php 

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 );
}

Uses

Uses Description
wp-includes/pluggable.php: get_userdata()

Retrieve user info by user ID.
wp-includes/functions.php: _deprecated_argument()

Mark a function argument as deprecated and inform when it has been used.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/user.php: get_user_option_{$option}

Filters a specific user option value.
wp-includes/user.php: get_current_user_id()

Get the current user’s ID
wp-includes/wp-db.php: wpdb::get_blog_prefix()

Gets blog prefix.

Used By

Used By Description
wp-includes/script-loader.php: wp_localize_community_events()

Localizes community events data that needs to be passed to dashboard.js.
wp-admin/includes/ajax-actions.php: wp_ajax_get_community_events()

Handles Ajax requests for community events
wp-admin/includes/post.php: wp_edit_attachments_query_vars()

Get the query variables for the current attachments request.
wp-admin/includes/class-wp-screen.php: WP_Screen::render_per_page_options()

Render the items per page option
wp-admin/includes/class-wp-screen.php: WP_Screen::render_screen_meta()

Render the screen’s help section.
wp-admin/includes/screen.php: get_hidden_columns()

Get a list of hidden columns.
wp-admin/includes/screen.php: get_hidden_meta_boxes()

Gets an array of IDs of hidden meta boxes.
wp-admin/includes/class-wp-list-table.php: WP_List_Table::get_items_per_page()

Gets the number of items to display on a single page.
wp-admin/includes/misc.php: admin_color_scheme_picker()

Display the default admin color scheme picker (Used in user-edit.php)
wp-admin/includes/misc.php: wp_color_scheme_settings()
wp-admin/includes/plugin-install.php: install_plugins_favorites_form()

Show a username form for the favorites page
wp-admin/includes/plugin-install.php: display_plugins_table()

Display plugin content based on plugin list.
wp-admin/includes/dashboard.php: wp_dashboard_quick_press()

The Quick Draft widget display and creation of drafts.
wp-admin/includes/user.php: 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/class-wp-plugin-install-list-table.php: WP_Plugin_Install_List_Table::prepare_items()
wp-admin/includes/template.php: do_meta_boxes()

Meta-Box template function.
wp-admin/includes/post.php: wp_edit_posts_query()

Run the wp query to fetch the posts for listing on the edit posts page
wp-admin/includes/post.php: postbox_classes()

Returns the list of classes to be used by a meta box.
wp-admin/includes/ajax-actions.php: wp_ajax_query_themes()

Ajax handler for getting themes from themes_api().
wp-admin/includes/nav-menu.php: wp_nav_menu_setup()

Register nav menu meta boxes and advanced menu items.
wp-admin/includes/nav-menu.php: wp_initial_nav_menu_meta_boxes()

Limit the amount of meta boxes to pages, posts, links, and categories for first time users.
wp-admin/includes/comment.php: enqueue_comment_hotkeys_js()
wp-includes/pluggable.php: auth_redirect()

Checks if a user is logged in, if not it redirects them to the login page.
wp-includes/general-template.php: user_can_richedit()

Whether the user can access the visual editor.
wp-includes/admin-bar.php: _get_admin_bar_pref()

Retrieve the admin bar display preference of a user.
wp-includes/option.php: wp_user_settings()

Saves and restores user interface settings stored in a cookie.
wp-includes/option.php: get_all_user_settings()

Retrieves all user interface settings.
wp-includes/script-loader.php: wp_style_loader_src()

Administration Screen CSS for changing the styles.

Changelog

Version Description
2.0.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_user_option