Search for help

  1. Search 7.x for help
  2. Search 9.5.x for help
  3. Search 8.9.x for help
  4. Search 11.x for help
  5. Search main for help
  6. Other projects
Title Object type File name Summary
HelpSearch::prepareResults function core/modules/help/src/Plugin/Search/HelpSearch.php Prepares search results for display.
HelpSearch::removeItemsFromIndex function core/modules/help/src/Plugin/Search/HelpSearch.php Removes an item or items from the search index.
HelpSearch::updateIndex function core/modules/help/src/Plugin/Search/HelpSearch.php Updates the search index for this plugin.
HelpSearch::updateIndexState function core/modules/help/src/Plugin/Search/HelpSearch.php Updates the 'help_search_unindexed_count' state variable.
HelpSearch::updateTopicList function core/modules/help/src/Plugin/Search/HelpSearch.php Rebuilds the database table containing topics to be indexed.
HelpSearch::__construct function core/modules/help/src/Plugin/Search/HelpSearch.php Constructs a \Drupal\help_search\Plugin\Search\HelpSearch object.
HelpSearchPluginTest class core/modules/help/tests/src/Kernel/HelpSearchPluginTest.php Tests search plugin behaviors.
HelpSearchPluginTest.php file core/modules/help/tests/src/Kernel/HelpSearchPluginTest.php
HelpSearchPluginTest::$modules property core/modules/help/tests/src/Kernel/HelpSearchPluginTest.php Modules to install.
HelpSearchPluginTest::testAnnotation function core/modules/help/tests/src/Kernel/HelpSearchPluginTest.php Tests search plugin annotation and interfaces.
HelpSection class core/modules/help/src/Attribute/HelpSection.php Defines a HelpSection attribute object for plugin discovery.
HelpSection class core/modules/help/src/Annotation/HelpSection.php Defines a Plugin annotation object for help page section plugins.
HelpSection.php file core/modules/help/src/Attribute/HelpSection.php
HelpSection.php file core/modules/help/src/Annotation/HelpSection.php
HelpSection::$description property core/modules/help/src/Annotation/HelpSection.php The description of the help page section.
HelpSection::$id property core/modules/help/src/Annotation/HelpSection.php The plugin ID.
HelpSection::$permission property core/modules/help/src/Annotation/HelpSection.php The (optional) permission needed to view the help section.
HelpSection::$title property core/modules/help/src/Annotation/HelpSection.php The text to use as the title of the help page section.
HelpSection::$weight property core/modules/help/src/Annotation/HelpSection.php An optional weight for the help section.
HelpSection::__construct function core/modules/help/src/Attribute/HelpSection.php Constructs a HelpSection attribute.
HelpSectionManager class core/modules/help_topics/src/HelpSectionManager.php Decorates the Help Section plugin manager to provide help topic search.
HelpSectionManager class core/modules/help/src/HelpSectionManager.php Manages help page section plugins.
HelpSectionManager.php file core/modules/help/src/HelpSectionManager.php
HelpSectionManager.php file core/modules/help_topics/src/HelpSectionManager.php
HelpSectionManager::$searchManager property core/modules/help/src/HelpSectionManager.php The search manager.
HelpSectionManager::clearCachedDefinitions function core/modules/help/src/HelpSectionManager.php Clears static and persistent plugin definition caches.
HelpSectionManager::setSearchManager function core/modules/help/src/HelpSectionManager.php Sets the search manager.
HelpSectionManager::__construct function core/modules/help/src/HelpSectionManager.php Constructs a new HelpSectionManager.
HelpSectionPluginBase class core/modules/help/src/Plugin/HelpSection/HelpSectionPluginBase.php Provides a base class for help section plugins.
HelpSectionPluginBase.php file core/modules/help/src/Plugin/HelpSection/HelpSectionPluginBase.php
HelpSectionPluginBase::getDescription function core/modules/help/src/Plugin/HelpSection/HelpSectionPluginBase.php Returns the description text for the help section.
HelpSectionPluginBase::getTitle function core/modules/help/src/Plugin/HelpSection/HelpSectionPluginBase.php Returns the title of the help section.
HelpSectionPluginInterface interface core/modules/help/src/HelpSectionPluginInterface.php Provides an interface for a plugin for a section of the /admin/help page.
HelpSectionPluginInterface.php file core/modules/help/src/HelpSectionPluginInterface.php
HelpSectionPluginInterface::getDescription function core/modules/help/src/HelpSectionPluginInterface.php Returns the description text for the help section.
HelpSectionPluginInterface::getTitle function core/modules/help/src/HelpSectionPluginInterface.php Returns the title of the help section.
HelpSectionPluginInterface::listTopics function core/modules/help/src/HelpSectionPluginInterface.php Returns a list of topics to show in the help section.
HelpTest class core/modules/help/tests/src/Functional/HelpTest.php Verify help display and user access to help based on permissions.
HelpTest.php file core/modules/help/tests/src/Functional/HelpTest.php
HelpTest::$adminUser property core/modules/help/tests/src/Functional/HelpTest.php The admin user that will be created.
HelpTest::$anyUser property core/modules/help/tests/src/Functional/HelpTest.php The anonymous user that will be created.
HelpTest::$defaultTheme property core/modules/help/tests/src/Functional/HelpTest.php The theme to install as the default for testing.
HelpTest::$modules property core/modules/help/tests/src/Functional/HelpTest.php Modules to install.
HelpTest::getModuleList function core/modules/help/tests/src/Functional/HelpTest.php Gets the list of enabled modules that implement hook_help().
HelpTest::setUp function core/modules/help/tests/src/Functional/HelpTest.php
HelpTest::testHelp function core/modules/help/tests/src/Functional/HelpTest.php Logs in users, tests help pages.
HelpTest::verifyHelp function core/modules/help/tests/src/Functional/HelpTest.php Verifies the logged in user has access to the various help pages.
HelpTestTwigExtension class core/modules/help/tests/modules/help_topics_twig_tester/src/HelpTestTwigExtension.php Defines and registers Drupal Twig extensions for testing help topics.
HelpTestTwigExtension.php file core/modules/help/tests/modules/help_topics_twig_tester/src/HelpTestTwigExtension.php
HelpTestTwigExtension::getNodeVisitors function core/modules/help/tests/modules/help_topics_twig_tester/src/HelpTestTwigExtension.php

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