Error message

You are browsing documentation for drupal 7.x, which is not supported anymore. Read the updated version of this page for drupal 11.x (the latest version).

function help_page

Menu callback; prints a page listing general help for a module.

Parameters

$name: A module name to display a help page for.

1 string reference to 'help_page'
help_menu in modules/help/help.module
Implements hook_menu().

File

modules/help/help.admin.inc, line 24

Code

function help_page ($name) {
 $output = '';
 if (module_hook ($name, 'help')) {
 $info = system_get_info ('module');
 drupal_set_title ($info[$name]['name']);
 $temp = module_invoke ($name, 'help', "admin/help#{$name}", drupal_help_arg ());
 if (empty($temp)) {
 $output .= t ("No help is available for module %module.", array(
 '%module' => $info[$name]['name'],
 ));
 }
 else {
 $output .= $temp;
 }
 // Only print list of administration pages if the module in question has
 // any such pages associated to it.
 $admin_tasks = system_get_module_admin_tasks ($name, $info[$name]);
 if (!empty($admin_tasks)) {
 $links = array();
 foreach ($admin_tasks as $task) {
 $links[] = l ($task['title'], $task['link_path'], $task['localized_options']);
 }
 $output .= theme ('item_list', array(
 'items' => $links,
 'title' => t ('@module administration pages', array(
 '@module' => $info[$name]['name'],
 )),
 ));
 }
 }
 return $output;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.