Home › API reference › block_example.module

block_example_help

  1. drupal
    1. 4.7
Versions
4.7 block_example_help($section)

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.

Code

developer/examples/block_example.module, line 18

<?php
function block_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 block.');
  }
}
?>