function admin_bar_suppress

1 admin_bar.module admin_bar_suppress($set = TRUE)

Suppress display of administration bar.

This function should be called from within another module's page callback (preferably using module_invoke()) when the menu should not be displayed. This is useful for modules that implement popup pages or other special pages where the menu would be distracting or break the layout.

Parameters

$set: Defaults to TRUE. If called before hook_footer(), the menu will not be displayed. If FALSE is passed, the suppression state is returned.

2 calls to admin_bar_suppress()

admin_bar_preprocess_page in core/modules/admin_bar/admin_bar.module: Implements hook_preprocess_page().
color_custom_theme in core/modules/color/color.module: Implements hook_custom_theme().

File

core/modules/admin_bar/admin_bar.module, line 289: Render an administrative bar as a dropdown menu at the top of the window.

Code

function admin_bar_suppress($set = TRUE) {
  static $suppress = FALSE;
  // backdrop_add_js() must only be invoked once.
  if (!empty($set) && $suppress === FALSE) {
    $suppress = TRUE;
    backdrop_add_js(array('admin_bar' => array('suppress' => 1)), 'setting');
  }
  return $suppress;
}