API@RTK0.NET

page_example_help

• Drupal 4.7
• Drupal 5

1. drupal
   1. 4.7
   2. 5
   3. 7 page_example.module

Implementation of hook_help().

Throughout Drupal, hook_help() is used to display help text at the top of pages. Some other parts of Drupal pages get explanatory text from these hooks as well. We use it here to provide a description of the module on the module administration page. This example also illustrates how to add help text to the pages your module defines.

Code

developer/examples/page_example.module, line 19

<?php
function page_example_help($section) {
  switch ($section) {
    case 'admin/modules#description':
      // This description is shown in the listing at admin/modules.
      return t('An example module showing how to define a page to be displayed to the user at a given URL.');
    case 'foo':
      // Here is some help text for a custom page.
      return t('This sentence contains all the letters in the English alphabet.');
  }
}
?>