function admin_menu_suppress in Administration menu 6

Same name and namespace in other branches

1. 8.3 admin_menu.module \admin_menu_suppress()
2. 5.3 admin_menu.module \admin_menu_suppress()
3. 5.2 admin_menu.module \admin_menu_suppress()
4. 6.3 admin_menu.module \admin_menu_suppress()
5. 7.3 admin_menu.module \admin_menu_suppress()

Suppress display of administration menu.

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. Calling with FALSE returns the suppression state.

1 call to admin_menu_suppress()

admin_menu_footer in ./admin_menu.module

Implementation of hook_footer().

File

./admin_menu.module, line 114

Renders a menu tree for administrative purposes as a dropdown menu at the top of the window.

Code

function admin_menu_suppress($set = TRUE) {
  static $suppress = FALSE;
  if (!empty($set)) {
    $suppress = TRUE;
  }
  return $suppress;
}