block_example_help

• Drupal 4.6
• Drupal 4.7

• View documentation
• List references

Definition

block_example_help($section)
developer/examples/block_example.module, line 17

Description

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

<?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.');
  }
}
?>