function hook_help_section_info_alter

Same name and namespace in other branches
  1. 9 core/modules/help/help.api.php \hook_help_section_info_alter()
  2. 8.9.x core/modules/help/help.api.php \hook_help_section_info_alter()
  3. 10 core/modules/help/help.api.php \hook_help_section_info_alter()

Perform alterations on help page section plugin definitions.

Sections for the page at /admin/help are provided by plugins. This hook allows modules to alter the plugin definitions.

Parameters

array $info: Array of plugin information exposed by hook page section plugins, altered by reference.

See also

\Drupal\help\HelpSectionPluginInterface

\Drupal\help\Annotation\HelpSection

\Drupal\help\HelpSectionManager

Related topics

1 function implements hook_help_section_info_alter()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

more_help_page_test_help_section_info_alter in core/modules/help/tests/modules/more_help_page_test/more_help_page_test.module
Implements hook_help_section_info_alter().
1 invocation of hook_help_section_info_alter()
HelpSectionManager::__construct in core/modules/help/src/HelpSectionManager.php
Constructs a new HelpSectionManager.

File

core/modules/help/help.api.php, line 97

Code

function hook_help_section_info_alter(array &$info) {
    // Alter the header for the module overviews section.
    $info['hook_help']['title'] = t('Overviews of modules');
    // Move the module overviews section to the end.
    $info['hook_help']['weight'] = 500;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.