hook_help
- Versions
- 4.6 – 5
hook_help($section)- 6 – 7
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.
For a detailed usage example, see page_example.module.
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/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')));
Related topics
Code
developer/hooks/core.php, line 509
<?php
function hook_help($section) {
switch ($section) {
case 'admin/help#block':
return '<p>'. t('Blocks are boxes of content that may be rendered into certain regions of your web pages, for example, into sidebars. Blocks are usually generated automatically by modules (e.g., Recent Forum Topics), but administrators can also define custom blocks.') .'</p>';
case 'admin/build/block':
return t('<p>Blocks are boxes of content that may be rendered into certain regions of your web pages, for example, into sidebars. They are usually generated automatically by modules, but administrators can create blocks manually.</p>
<p>If you want certain blocks to disable themselves temporarily during high server loads, check the "Throttle" box. You can configure the auto-throttle on the <a href="@throttle">throttle configuration page</a> after having enabled the throttle module.</p>
<p>You can configure the behaviour of each block (for example, specifying on which pages and for what users it will appear) by clicking the "configure" link for each block.</p>', array('@throttle' => url('admin/settings/throttle')));
}
}
?>