function SearchableHelpInterface::listSearchableTopics

Same name in other branches
  1. 9 core/modules/help_topics/src/SearchableHelpInterface.php \Drupal\help_topics\SearchableHelpInterface::listSearchableTopics()
  2. 8.9.x core/modules/help_topics/src/SearchableHelpInterface.php \Drupal\help_topics\SearchableHelpInterface::listSearchableTopics()
  3. 11.x core/modules/help/src/SearchableHelpInterface.php \Drupal\help\SearchableHelpInterface::listSearchableTopics()

Returns the IDs of topics that should be indexed for searching.

Return value

string[] An array of topic IDs that should be searchable. IDs need to be unique within this HelpSection plugin.

2 methods override SearchableHelpInterface::listSearchableTopics()
HelpTopicSection::listSearchableTopics in core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php
Returns the IDs of topics that should be indexed for searching.
TestHelpSection::listSearchableTopics in core/modules/help/tests/modules/help_topics_test/src/Plugin/HelpSection/TestHelpSection.php
Returns the IDs of topics that should be indexed for searching.

File

core/modules/help/src/SearchableHelpInterface.php, line 21

Class

SearchableHelpInterface
Provides an interface for a HelpSection plugin that also supports search.

Namespace

Drupal\help

Code

public function listSearchableTopics();

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