menu_get_active_help

• Drupal 4.6
• Drupal 4.7
• Drupal 5
• Drupal 6
• Drupal 7

Versions

4.6 – 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.

Code

includes/menu.inc, line 1462

<?php
function menu_get_active_help() {
  $output = '';
  $router_path = menu_tab_root_path();
  // We will always have a path unless we are on a 403 or 404.
  if (!$router_path) {
    return '';
  }

  $arg = drupal_help_arg(arg(NULL));
  $empty_arg = drupal_help_arg();

  foreach (module_implements('help') as $module) {
    $function = $module . '_help';
    // Lookup help for this path.
    if ($help = $function($router_path, $arg)) {
      $output .= $help . "\n";
    }
    // Add "more help" link on admin pages if the module provides a
    // standalone help page.
    if ($arg[0] == "admin" && user_access('access administration pages') && module_exists('help') && $function('admin/help#' . $arg[2], $empty_arg) && $help) {
      $output .= theme("more_help_link", array('url' => url('admin/help/' . $arg[2])));
    }
  }
  return $output;
}
?>

Login or register to post comments