class HelpSearch

Handles searching for help using the Search module index.

Help items are indexed if their HelpSection plugin implements \Drupal\help\HelpSearchInterface.

@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.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
    • class \Drupal\search\Plugin\SearchPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\search\Plugin\SearchInterface, \Drupal\Core\Cache\RefinableCacheableDependencyInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait
      • class \Drupal\help\Plugin\Search\HelpSearch extends \Drupal\search\Plugin\SearchPluginBase implements \Drupal\Core\Access\AccessibleInterface, \Drupal\search\Plugin\SearchIndexingInterface
        • class \Drupal\help_topics\Plugin\Search\HelpSearch extends \Drupal\help\Plugin\Search\HelpSearch

Expanded class hierarchy of HelpSearch

See also

\Drupal\help\HelpSearchInterface

\Drupal\help\HelpSectionPluginInterface

File

core/modules/help_topics/src/Plugin/Search/HelpSearch.php, line 21

Namespace

class HelpSearch extends CoreHelpSearch {

}