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

In this article

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

Changelog

VersionDescription
3.1.0Introduced.

User Contributed Notes

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