function HelpSectionPluginInterface::listTopics

Same name in other branches
  1. 8.9.x core/modules/help/src/HelpSectionPluginInterface.php \Drupal\help\HelpSectionPluginInterface::listTopics()
  2. 10 core/modules/help/src/HelpSectionPluginInterface.php \Drupal\help\HelpSectionPluginInterface::listTopics()
  3. 11.x core/modules/help/src/HelpSectionPluginInterface.php \Drupal\help\HelpSectionPluginInterface::listTopics()

Returns a list of topics to show in the help section.

Return value

array A sorted list of topic links or render arrays for topic links. The links will be shown in the help section; if the returned array of links is empty, the section will be shown with some generic empty text.

5 methods override HelpSectionPluginInterface::listTopics()
EmptyHelpSection::listTopics in core/modules/help/tests/modules/help_page_test/src/Plugin/HelpSection/EmptyHelpSection.php
Returns a list of topics to show in the help section.
HelpTopicSection::listTopics in core/modules/help_topics/src/Plugin/HelpSection/HelpTopicSection.php
Returns a list of topics to show in the help section.
HookHelpSection::listTopics in core/modules/help/src/Plugin/HelpSection/HookHelpSection.php
Returns a list of topics to show in the help section.
TestHelpSection::listTopics in core/modules/help_topics/tests/modules/help_topics_test/src/Plugin/HelpSection/TestHelpSection.php
Returns a list of topics to show in the help section.
TourHelpSection::listTopics in core/modules/tour/src/Plugin/HelpSection/TourHelpSection.php
Returns a list of topics to show in the help section.

File

core/modules/help/src/HelpSectionPluginInterface.php, line 46

Class

HelpSectionPluginInterface
Provides an interface for a plugin for a section of the /admin/help page.

Namespace

Drupal\help

Code

public function listTopics();

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