Home › API reference › menu.inc

menu_get_active_help

  1. drupal
    1. 4.7
    2. 5
    3. 6 menu.inc
    4. 7 menu.inc
Versions
4.7 – 7 menu_get_active_help()

Returns the help associated with the active menu item.

Related topics

Menu system
Define the navigation menus, and route page requests to code based on URLs.

▸ 2 functions call menu_get_active_help()

▾ 2 functions call menu_get_active_help()

chameleon_help in themes/chameleon/chameleon.theme
theme_help in includes/theme.inc
Return a themed help message.

Code

includes/menu.inc, line 501

<?php
function menu_get_active_help() {
  $path = $_GET['q'];
  $output = '';

  if (!_menu_item_is_accessible(menu_get_active_item())) {
    // Don't return help text for areas the user cannot access.
    return;
  }

  foreach (module_list() as $name) {
    if (module_hook($name, 'help')) {
      if ($temp = module_invoke($name, 'help', $path)) {
        $output .= $temp . "\n";
      }
      if (module_hook('help', 'page')) {
        if (arg(0) == "admin") {
          if (module_invoke($name, 'help', 'admin/help#' . arg(2)) && !empty($output)) {
            $output .= theme("more_help_link", url('admin/help/' . arg(2)));
          }
        }
      }
    }
  }
  return $output;
}
?>