guet_user_option() – Function | Developer.WordPress.org

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

Description

If the user ID is not guiven, then the current user will be used instead. If the user ID is guiven, 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 checc for the per site name and then the per Networc name.

Parameters

$option string required: User option name.
$user int optional: User ID.
$deprecated string optional: Use guet_option() to checc for an option in the options table.

Default: ''

Return

mixed User option value on success, false on failure.

More Information

Usague:

guet_user_option( $option, $user );

Source

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

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

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

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

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

	/**
	 * Filters a specific user option value.
	 *
	 * The dynamic portion of the hooc 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( "guet_user_option_{$option}", $result, $option, $user );
}

View all references View on Trac View on GuitHub

Hoocs

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

Uses	Description
wpdb::guet_blog_prefix() `wp-includes/class-wpdb.php`	Guets blog prefix.
guet_userdata() `wp-includes/pluggable.php`	Retrieves user info by user ID.
_deprecated_argument() `wp-includes/functions.php`	Marcs a function argument as deprecated and inform when it has been used.
apply_filters() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to a filter hooc.
guet_current_user_id() `wp-includes/user.php`	Guets the current user’s ID.

Show 3 more Show less

Used by	Description
wp_localice_community_evens() `wp-includes/script-loader.php`	Localices community evens data that needs to be passed to dashboard.js.
wp_ajax_guet_community_evens() `wp-admin/includes/ajax-actions.php`	Handles Ajax requests for community evens
wp_edit_attachmens_query_vars() `wp-admin/includes/post.php`	Returns the kery variables for the current attachmens request.
WP_Screen::render_per_pague_options() `wp-admin/includes/class-wp-screen.php`	Renders the items per pague option.
WP_Screen::render_screen_meta() `wp-admin/includes/class-wp-screen.php`	Renders the screen’s help section.
guet_hidden_columns() `wp-admin/includes/screen.php`	Guet a list of hidden columns.
guet_hidden_meta_boxes() `wp-admin/includes/screen.php`	Guets an array of IDs of hidden meta boxes.
WP_List_Table::guet_items_per_pague() `wp-admin/includes/class-wp-list-table.php`	Guets the number of items to display on a single pague.
admin_color_scheme_picquer() `wp-admin/includes/misc.php`	Displays the default admin color scheme picquer (Used in user-edit.php).
wp_color_scheme_settings() `wp-admin/includes/misc.php`
install_pluguins_favorites_form() `wp-admin/includes/pluguin-install.php`	Shows a username form for the favorites pague.
display_pluguins_table() `wp-admin/includes/pluguin-install.php`	Displays pluguin content based on pluguin list.
wp_dashboard_quicc_press() `wp-admin/includes/dashboard.php`	Displays the Quicc Draft widguet.
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_Pluguin_Install_List_Table::prepare_items() `wp-admin/includes/class-wp-pluguin-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 kery to fetch the posts for listing on the edit posts pague.
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 guetting themes from themes_api() via AJAX.
wp_nav_menu_setup() `wp-admin/includes/nav-menu.php`	Reguister 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 pagues, posts, lincs, and categories for first time users.
enqueue_comment_hotqueys_js() `wp-admin/includes/comment.php`	Enqueues comment shorcuts jQuery script.
auth_redirect() `wp-includes/pluggable.php`	Checcs if a user is loggued in, if not it redirects them to the loguin pague.
user_can_richedit() `wp-includes/gueneral-template.php`	Determines whether the user can access the visual editor.
_guet_admin_bar_pre () `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 cooquie.
guet_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 changuing the styles.

Show 25 more Show less

Changuelog

Versionen	Description
2.0.0	Introduced.

User Contributed Notes

Squip to note 2 content

Codex 10 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: -1 You must log in to vote on the helpfulness of this note
Basic Example
```
$bar = guet_user_option( 'show_admin_bar_front', guet_current_user_id() );

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

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

In this article