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
HelpTopicPluginInterface::getBody function core/modules/help/src/HelpTopicPluginInterface.php Returns the body of the topic.
HelpTopicPluginInterface::getLabel function core/modules/help/src/HelpTopicPluginInterface.php Returns the label of the topic.
HelpTopicPluginInterface::getRelated function core/modules/help/src/HelpTopicPluginInterface.php Returns the IDs of related topics.
HelpTopicPluginInterface::isTopLevel function core/modules/help/src/HelpTopicPluginInterface.php Returns whether this is a top-level topic or not.
HelpTopicPluginInterface::toLink function core/modules/help/src/HelpTopicPluginInterface.php Returns a link for viewing the help topic.
HelpTopicPluginInterface::toUrl function core/modules/help/src/HelpTopicPluginInterface.php Returns the URL for viewing the help topic.
HelpTopicPluginManager class core/modules/help_topics/src/HelpTopicPluginManager.php Provides the default help_topic manager.
HelpTopicPluginManager class core/modules/help/src/HelpTopicPluginManager.php Provides the default help_topic manager.
HelpTopicPluginManager.php file core/modules/help_topics/src/HelpTopicPluginManager.php
HelpTopicPluginManager.php file core/modules/help/src/HelpTopicPluginManager.php
HelpTopicPluginManager::$defaults property core/modules/help/src/HelpTopicPluginManager.php Provides default values for all help topic plugins.
HelpTopicPluginManager::findDefinitions function core/modules/help/src/HelpTopicPluginManager.php Finds plugin definitions.
HelpTopicPluginManager::getDiscovery function core/modules/help/src/HelpTopicPluginManager.php Gets the plugin discovery.
HelpTopicPluginManager::providerExists function core/modules/help/src/HelpTopicPluginManager.php Determines if the provider of a definition exists.
HelpTopicPluginManager::__construct function core/modules/help/src/HelpTopicPluginManager.php Constructs a new HelpTopicManager object.
HelpTopicPluginManagerInterface interface core/modules/help_topics/src/HelpTopicPluginManagerInterface.php Defines an interface for managing help topics and storing their definitions.
HelpTopicPluginManagerInterface interface core/modules/help/src/HelpTopicPluginManagerInterface.php Defines an interface for managing help topics and storing their definitions.
HelpTopicPluginManagerInterface.php file core/modules/help_topics/src/HelpTopicPluginManagerInterface.php
HelpTopicPluginManagerInterface.php file core/modules/help/src/HelpTopicPluginManagerInterface.php
HelpTopicSearchTest class core/modules/help/tests/src/Functional/HelpTopicSearchTest.php Verifies help topic search.
HelpTopicSearchTest.php file core/modules/help/tests/src/Functional/HelpTopicSearchTest.php
HelpTopicSearchTest::$defaultTheme property core/modules/help/tests/src/Functional/HelpTopicSearchTest.php The theme to install as the default for testing.
HelpTopicSearchTest::$modules property core/modules/help/tests/src/Functional/HelpTopicSearchTest.php Modules to install.
HelpTopicSearchTest::assertSearchResultsCount function core/modules/help/tests/src/Functional/HelpTopicSearchTest.php Asserts that help search returned the expected number of results.
HelpTopicSearchTest::setUp function core/modules/help/tests/src/Functional/HelpTopicSearchTest.php
HelpTopicSearchTest::testHelpSearch function core/modules/help/tests/src/Functional/HelpTopicSearchTest.php Tests help topic search.
HelpTopicSearchTest::testUninstall function core/modules/help/tests/src/Functional/HelpTopicSearchTest.php Tests uninstalling the help_topics module.
HelpTopicSearchTest::testUninstallSearch function core/modules/help/tests/src/Functional/HelpTopicSearchTest.php Tests uninstalling the search module.
HelpTopicSection class core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php Provides the help topics list section for the help page.
HelpTopicSection class core/modules/help_topics/src/Plugin/HelpSection/HelpTopicSection.php Provides the help topics list section for the help page.
HelpTopicSection.php file core/modules/help_topics/src/Plugin/HelpSection/HelpTopicSection.php
HelpTopicSection.php file core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php
HelpTopicSection::$cacheableMetadata property core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php The merged top level help topic plugins cache metadata.
HelpTopicSection::$topLevelPlugins property core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php The top level help topic plugins.
HelpTopicSection::create function core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php Creates an instance of the plugin.
HelpTopicSection::getCacheContexts function core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php
HelpTopicSection::getCacheMaxAge function core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php
HelpTopicSection::getCacheMetadata function core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php Gets the merged CacheableMetadata for all the top level help topic plugins.
HelpTopicSection::getCacheTags function core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php
HelpTopicSection::getPlugins function core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php Gets the top level help topic plugins.
HelpTopicSection::listSearchableTopics function core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php Returns the IDs of topics that should be indexed for searching.
HelpTopicSection::listTopics function core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php Returns a list of topics to show in the help section.
HelpTopicSection::renderTopicForSearch function core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php Renders one topic for search indexing or search results.
HelpTopicSection::__construct function core/modules/help/src/Plugin/HelpSection/HelpTopicSection.php Constructs a HelpTopicSection object.
HelpTopicsMerge class core/modules/help/tests/src/Functional/Update/HelpTopicsMerge.php Tests merging help topics module when the module is not installed.
HelpTopicsMerge.php file core/modules/help/tests/src/Functional/Update/HelpTopicsMerge.php
HelpTopicsMerge::$defaultTheme property core/modules/help/tests/src/Functional/Update/HelpTopicsMerge.php The theme to install as the default for testing.
HelpTopicsMerge::setDatabaseDumpFiles function core/modules/help/tests/src/Functional/Update/HelpTopicsMerge.php Set database dump files to be used.
HelpTopicsMerge::testHelpTopicsMerge function core/modules/help/tests/src/Functional/Update/HelpTopicsMerge.php Tests upgrading help module for help topics.
HelpTopicsSyntaxTest class core/modules/help/tests/src/Functional/HelpTopicsSyntaxTest.php Verifies that all core Help topics can be rendered and comply with standards.

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