| 5 core.php | hook_help( |
| 6 core.php | hook_help($path, $arg) |
| 7 help.api.php | hook_help($path, $arg) |
| 8 help.api.php | hook_help($path, $arg) |
Provide online user help.
By implementing hook_help(), a module can make documentation available to the engine or to other modules. All user help should be returned using this hook; developer help should be provided with Doxygen/api.module comments.
Parameters
$section: Drupal URL path (or: menu item) the help is being requested for, e.g. admin/node or user/edit. Recognizes special descriptors after a "#" sign. Some examples:
- admin/modules#name The name of a module (unused, but there)
- admin/modules#description The description found on the admin/system/modules page.
- admin/help#modulename The module's help text, displayed on the admin/help page and through the module's individual help link.
- user/help#modulename The help for a distributed authorization module (if applicable).
- node/add#nodetype The description of a node type (if applicable).
Return value
A localized string containing the help text. Every web link, l(), or url() must be replaced with %something and put into the final t() call: $output .= 'A role defines a group of users that have certain privileges as defined in %permission.'; $output = t($output, array('%permission' => l(t('user permissions'), 'admin/user/permission')));
For a detailed usage example, see page_example.module.
Related topics
File
- developer/
hooks/ core.php, line 472 - These are the hooks that are invoked by the Drupal core.
Code
<?php
function hook_help($section) {
switch ($section) {
case 'admin/help#block':
return t('<p>Blocks are the boxes visible in the sidebar(s)
of your web site. These are usually generated automatically by
modules (e.g. recent forum topics), but you can also create your
own blocks using either static HTML or dynamic PHP content.</p>');
break;
case 'admin/modules#description':
return t('Controls the boxes that are displayed around the main content.');
break;
}
}
?>