function hook_help_topics_info_alter

Same name in other branches
  1. 8.9.x core/modules/help_topics/help_topics.api.php \hook_help_topics_info_alter()
  2. 10 core/modules/help/help.api.php \hook_help_topics_info_alter()
  3. 11.x core/modules/help/help.api.php \hook_help_topics_info_alter()

Perform alterations on help topic definitions.

@internal Help Topics is currently experimental and should only be leveraged by experimental modules and development releases of contributed modules. See https://www.drupal.org/core/experimental for more information.

Parameters

array $info: Array of help topic plugin definitions keyed by their plugin ID.

Related topics

Hooks
Define functions that alter the behavior of Drupal core.
1 function implements hook_help_topics_info_alter()

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

help_topics_test_help_topics_info_alter in core/modules/help_topics/tests/modules/help_topics_test/help_topics_test.module
Implements hook_help_topics_info_alter().
1 invocation of hook_help_topics_info_alter()
HelpTopicPluginManager::__construct in core/modules/help_topics/src/HelpTopicPluginManager.php
Constructs a new HelpTopicManager object.

File

core/modules/help_topics/help_topics.api.php, line 54

Code

function hook_help_topics_info_alter(array &$info) {
    // Alter the help topic to be displayed on admin/help.
    $info['example.help_topic']['top_level'] = TRUE;
}

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