Search for help

  1. Search 7.x for help
  2. Search 9.5.x for help
  3. Search 10.3.x for help
  4. Search 11.x for help
  5. Search main for help
  6. Other projects
Title Object type File name Summary
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 enable.
HelpTest::$profile property core/modules/help/tests/src/Functional/HelpTest.php Use the Standard profile to test help implementations of many core modules.
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.
HelpTopicDiscovery class core/modules/help_topics/src/HelpTopicDiscovery.php Discovers help topic plugins from Twig files in help_topics directories.
HelpTopicDiscovery.php file core/modules/help_topics/src/HelpTopicDiscovery.php
HelpTopicDiscovery::$directories property core/modules/help_topics/src/HelpTopicDiscovery.php An array of directories to scan, keyed by the provider.
HelpTopicDiscovery::FILE_KEY constant core/modules/help_topics/src/HelpTopicDiscovery.php Defines the key in the discovered data where the file path is stored.
HelpTopicDiscovery::findAll function core/modules/help_topics/src/HelpTopicDiscovery.php Returns an array of discoverable items.
HelpTopicDiscovery::findFiles function core/modules/help_topics/src/HelpTopicDiscovery.php Returns an array of providers keyed by file path.
HelpTopicDiscovery::getDefinitions function core/modules/help_topics/src/HelpTopicDiscovery.php Gets the definition of all plugins for this type.
HelpTopicDiscovery::__construct function core/modules/help_topics/src/HelpTopicDiscovery.php Constructs a HelpTopicDiscovery object.
HelpTopicDiscoveryTest class core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php @coversDefaultClass \Drupal\help_topics\HelpTopicDiscovery[[api-linebreak]]
@group help_topics
HelpTopicDiscoveryTest.php file core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php
HelpTopicDiscoveryTest::testDiscoveryExceptionInvalidRelated function core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testDiscoveryExceptionInvalidTopLevel function core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testDiscoveryExceptionInvalidYamlKey function core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testDiscoveryExceptionMissingLabel function core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testDiscoveryExceptionProviderMismatch function core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testHelpTopicsBrokenYaml function core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testHelpTopicsDefinition function core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testHelpTopicsExtensionProviderSpecialCase function core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php @covers ::findAll[[api-linebreak]]
HelpTopicDiscoveryTest::testHelpTopicsInCore function core/modules/help_topics/tests/src/Unit/HelpTopicDiscoveryTest.php @covers ::findAll[[api-linebreak]]
HelpTopicPluginBase class core/modules/help_topics/src/HelpTopicPluginBase.php Base class for help topic plugins.
HelpTopicPluginBase.php file core/modules/help_topics/src/HelpTopicPluginBase.php
HelpTopicPluginBase::getLabel function core/modules/help_topics/src/HelpTopicPluginBase.php Returns the label of the topic.
HelpTopicPluginBase::getProvider function core/modules/help_topics/src/HelpTopicPluginBase.php The name of the module or theme providing the help topic.
HelpTopicPluginBase::getRelated function core/modules/help_topics/src/HelpTopicPluginBase.php Returns the IDs of related topics.
HelpTopicPluginBase::isTopLevel function core/modules/help_topics/src/HelpTopicPluginBase.php Returns whether this is a top-level topic or not.
HelpTopicPluginBase::toLink function core/modules/help_topics/src/HelpTopicPluginBase.php Returns a link for viewing the help topic.
HelpTopicPluginBase::toUrl function core/modules/help_topics/src/HelpTopicPluginBase.php Returns the URL for viewing the help topic.
HelpTopicPluginController class core/modules/help_topics/src/Controller/HelpTopicPluginController.php Controller for help topic plugins.
HelpTopicPluginController.php file core/modules/help_topics/src/Controller/HelpTopicPluginController.php
HelpTopicPluginController::$helpTopicPluginManager property core/modules/help_topics/src/Controller/HelpTopicPluginController.php The Help Topic plugin manager.
HelpTopicPluginController::$renderer property core/modules/help_topics/src/Controller/HelpTopicPluginController.php The renderer service.
HelpTopicPluginController::create function core/modules/help_topics/src/Controller/HelpTopicPluginController.php Instantiates a new instance of this class.
HelpTopicPluginController::viewHelpTopic function core/modules/help_topics/src/Controller/HelpTopicPluginController.php Displays a help topic page.

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