WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

_get_admin_bar_pref()

_get_admin_bar_pref( string $context = 'front', int $user ): bool

In this article

Back to top

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

Retrieves the admin bar display preference of a user.

Parameters

$contextstringoptional
Context of this preference check. Defaults to 'front'. The 'admin' preference is no longer used.

Default:'front'

$userintoptional
ID of the user to check, defaults to 0 for current user.

Return

bool Whether the admin bar should be showing for this user.

Source

function _get_admin_bar_pref( $context = 'front', $user = 0 ) {
	$pref = get_user_option( "show_admin_bar_{$context}", $user );
	if ( false === $pref ) {
		return true;
	}

	return 'true' === $pref;
}

View all references View on Trac View on GitHub

UsesDescription
get_user_option()wp-includes/user.php

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

Used byDescription
is_admin_bar_showing()wp-includes/admin-bar.php

Determines whether the admin bar should be showing.

Changelog

VersionDescription
3.1.0Introduced.

User Contributed Notes

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