Working with Drupal's Help system

Last updated on
2 April 2017

The core Help module supports Drupal's built-in help system. Its Help landing page appears by default in the administrative GUI of a site.

(Do not confuse core Help with the contributed Help module. The latter has nothing to do with Drupal's help system.)

Core Help landing page

The core Help landing page provides an overview (like a table of contents), of all enabled modules in a site, for which Help is available. The image here contains a sample of such overview.

Contextual help in Drupal 7

The main reference Help pages can be accessed by navigating to Administer > Help in the Toolbar in Drupal 7.

As an alternative, use an URL like .../admin/help in any version of Drupal.

As of Drupal 7 you can also access the help pages via any of the "Get help" links on the Module administration page (Administer > Modules or using an URL like .../admin/modules).

How to access Help in Drupal 7

The help text provided via the Help module (via help hooks in each individual module) displays a brief explanation of various settings, uses, and configuration options, to help guide administrators and users. Administrators cannot alter the help system's text, as it is built into each module's code.

Drupal 7 module help page and link to online documentation

Each module's help page also references its corresponding online documentation module page. The online documentation contains more extensive and up-to-date information and serves as the definitive reference point for all Drupal documentation.

Request to Module maintainers: Please see the Help text documentation template to make sure your help hook matches the standard for all core and contributed modules.