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
HelpController::$moduleExtensionList property core/modules/help/src/Controller/HelpController.php The module extension list.
HelpController::$modulePermissionsLinks property core/modules/help/src/Controller/HelpController.php The module permissions link service.
HelpController::$routeMatch property core/modules/help/src/Controller/HelpController.php The current route match.
HelpController::create function core/modules/help/src/Controller/HelpController.php Instantiates a new instance of the implementing class using autowiring.
HelpController::helpMain function core/modules/help/src/Controller/HelpController.php Prints a page listing various types of help.
HelpController::helpPage function core/modules/help/src/Controller/HelpController.php Prints a page listing general help for a module.
HelpController::__construct function core/modules/help/src/Controller/HelpController.php Creates a new HelpController.
HelpEmptyPageTest class core/modules/help/tests/src/Kernel/HelpEmptyPageTest.php Tests the empty HTML page.
HelpEmptyPageTest.php file core/modules/help/tests/src/Kernel/HelpEmptyPageTest.php
HelpEmptyPageTest::$modules property core/modules/help/tests/src/Kernel/HelpEmptyPageTest.php Modules to install.
HelpEmptyPageTest::register function core/modules/help/tests/src/Kernel/HelpEmptyPageTest.php Registers test-specific services.
HelpEmptyPageTest::testEmptyHookHelp function core/modules/help/tests/src/Kernel/HelpEmptyPageTest.php Ensures that no URL generator is called on a page without hook_help().
HelpPageOrderTest class core/modules/help/tests/src/Functional/HelpPageOrderTest.php Verify the order of the help page.
HelpPageOrderTest.php file core/modules/help/tests/src/Functional/HelpPageOrderTest.php
HelpPageOrderTest::$defaultTheme property core/modules/help/tests/src/Functional/HelpPageOrderTest.php The theme to install as the default for testing.
HelpPageOrderTest::$modules property core/modules/help/tests/src/Functional/HelpPageOrderTest.php Modules to install.
HelpPageOrderTest::$stringOrder property core/modules/help/tests/src/Functional/HelpPageOrderTest.php Strings to search for on admin/help, in order.
HelpPageOrderTest::setUp function core/modules/help/tests/src/Functional/HelpPageOrderTest.php
HelpPageOrderTest::testHelp function core/modules/help/tests/src/Functional/HelpPageOrderTest.php Tests the order of the help page.
HelpPageReverseOrderTest class core/modules/help/tests/src/Functional/HelpPageReverseOrderTest.php Verify the order of the help page with an alter hook.
HelpPageReverseOrderTest.php file core/modules/help/tests/src/Functional/HelpPageReverseOrderTest.php
HelpPageReverseOrderTest::$defaultTheme property core/modules/help/tests/src/Functional/HelpPageReverseOrderTest.php The theme to install as the default for testing.
HelpPageReverseOrderTest::$modules property core/modules/help/tests/src/Functional/HelpPageReverseOrderTest.php Modules to install.
HelpPageReverseOrderTest::$stringOrder property core/modules/help/tests/src/Functional/HelpPageReverseOrderTest.php Strings to search for on admin/help, in order.
HelpPageTestController class core/modules/help/tests/modules/help_page_test/src/HelpPageTestController.php Provides controllers for testing the help block.
HelpPageTestController.php file core/modules/help/tests/modules/help_page_test/src/HelpPageTestController.php
HelpPageTestController::hasHelp function core/modules/help/tests/modules/help_page_test/src/HelpPageTestController.php Provides a route with help.
HelpPageTestController::noHelp function core/modules/help/tests/modules/help_page_test/src/HelpPageTestController.php Provides a route with no help.
HelpPageTestController::testArray function core/modules/help/tests/modules/help_page_test/src/HelpPageTestController.php Provides a route which has multiple array returns from hook_help().
HelpSearch class core/modules/help/src/Plugin/Search/HelpSearch.php Handles searching for help using the Search module index.
HelpSearch class core/modules/help_topics/src/Plugin/Search/HelpSearch.php Handles searching for help using the Search module index.
HelpSearch.php file core/modules/help_topics/src/Plugin/Search/HelpSearch.php
HelpSearch.php file core/modules/help/src/Plugin/Search/HelpSearch.php
HelpSearch::$account property core/modules/help/src/Plugin/Search/HelpSearch.php The Drupal account to use for checking for access to search.
HelpSearch::$database property core/modules/help/src/Plugin/Search/HelpSearch.php The current database connection.
HelpSearch::$helpSectionManager property core/modules/help/src/Plugin/Search/HelpSearch.php The help section plugin manager.
HelpSearch::$languageManager property core/modules/help/src/Plugin/Search/HelpSearch.php The language manager.
HelpSearch::$messenger property core/modules/help/src/Plugin/Search/HelpSearch.php The messenger.
HelpSearch::$searchIndex property core/modules/help/src/Plugin/Search/HelpSearch.php The search index.
HelpSearch::$searchSettings property core/modules/help/src/Plugin/Search/HelpSearch.php A config object for 'search.settings'.
HelpSearch::$state property core/modules/help/src/Plugin/Search/HelpSearch.php The state object.
HelpSearch::access function core/modules/help/src/Plugin/Search/HelpSearch.php Checks data value access.
HelpSearch::create function core/modules/help/src/Plugin/Search/HelpSearch.php Creates an instance of the plugin.
HelpSearch::execute function core/modules/help/src/Plugin/Search/HelpSearch.php Executes the search.
HelpSearch::findResults function core/modules/help/src/Plugin/Search/HelpSearch.php Finds the search results.
HelpSearch::getSectionPlugin function core/modules/help/src/Plugin/Search/HelpSearch.php Instantiates a help section plugin and verifies it is searchable.
HelpSearch::getType function core/modules/help/src/Plugin/Search/HelpSearch.php Returns the search index type this plugin uses.
HelpSearch::indexClear function core/modules/help/src/Plugin/Search/HelpSearch.php Clears the search index for this plugin.
HelpSearch::indexStatus function core/modules/help/src/Plugin/Search/HelpSearch.php Reports the status of indexing.
HelpSearch::markForReindex function core/modules/help/src/Plugin/Search/HelpSearch.php Marks the search index for reindexing for this plugin.

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