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 10.3.x for help
  5. Search 11.x for help
  6. Other projects
Title Object type File name Summary
SearchableHelpInterface::renderTopicForSearch function core/modules/help/src/SearchableHelpInterface.php Renders one topic for search indexing or search results.
SearchController::searchHelp function core/modules/search/src/Controller/SearchController.php Creates a render array for the search help page.
SearchHelpHelpPageTest class core/modules/search/modules/search_help/tests/src/Functional/SearchHelpHelpPageTest.php Verifies that search_help extends the main help page.
SearchHelpHelpPageTest.php file core/modules/search/modules/search_help/tests/src/Functional/SearchHelpHelpPageTest.php
SearchHelpHelpPageTest::$defaultTheme property core/modules/search/modules/search_help/tests/src/Functional/SearchHelpHelpPageTest.php The theme to install as the default for testing.
SearchHelpHelpPageTest::$modules property core/modules/search/modules/search_help/tests/src/Functional/SearchHelpHelpPageTest.php Modules to install.
SearchHelpHelpPageTest::testHelpPages function core/modules/search/modules/search_help/tests/src/Functional/SearchHelpHelpPageTest.php Tests that the help search section is added to and removed from the page.
SearchHelpHooks class core/modules/search/modules/search_help/src/Hook/SearchHelpHooks.php Hook implementations for help.
SearchHelpHooks.php file core/modules/search/modules/search_help/src/Hook/SearchHelpHooks.php
SearchHelpHooks::help function core/modules/search/modules/search_help/src/Hook/SearchHelpHooks.php Implements hook_help() on behalf of the help module.
SearchHelpHooks::modulesInstalled function core/modules/search/modules/search_help/src/Hook/SearchHelpHooks.php Implements hook_modules_installed().
SearchHelpHooks::modulesUninstalled function core/modules/search/modules/search_help/src/Hook/SearchHelpHooks.php Implements hook_modules_uninstalled().
SearchHelpHooks::rebuild function core/modules/search/modules/search_help/src/Hook/SearchHelpHooks.php Implements hook_rebuild().
SearchHelpHooks::searchUpdate function core/modules/search/modules/search_help/src/Hook/SearchHelpHooks.php Ensure that search is updated when extensions are installed or uninstalled.
SearchHelpHooks::themesInstallOrUninstall function core/modules/search/modules/search_help/src/Hook/SearchHelpHooks.php Implements hook_themes_installed().
SearchHelpHooks::__construct function core/modules/search/modules/search_help/src/Hook/SearchHelpHooks.php
SearchHelpSearch class core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php Handles searching for help using the Search module index.
SearchHelpSearch.php file core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php
SearchHelpSearch::$messenger property core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php The messenger.
SearchHelpSearch::access function core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php Checks data value access.
SearchHelpSearch::create function core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php Instantiates a new instance of the implementing class using autowiring.
SearchHelpSearch::ensureTableExists function core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php Check if the help_search_items table exists and create it if not.
SearchHelpSearch::execute function core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php Executes the search.
SearchHelpSearch::findResults function core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php Finds the search results.
SearchHelpSearch::getSectionPlugin function core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php Instantiates a help section plugin and verifies it is searchable.
SearchHelpSearch::getType function core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php Returns the search index type this plugin uses.
SearchHelpSearch::indexClear function core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php Clears the search index for this plugin.
SearchHelpSearch::indexStatus function core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php Reports the status of indexing.
SearchHelpSearch::markForReindex function core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php Marks the search index for reindexing for this plugin.
SearchHelpSearch::prepareResults function core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php Prepares search results for display.
SearchHelpSearch::removeItemsFromIndex function core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php Removes an item or items from the search index.
SearchHelpSearch::schemaDefinition function core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php Provides the schema definition for the help_search_items table.
SearchHelpSearch::updateIndex function core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php Updates the search index for this plugin.
SearchHelpSearch::updateIndexState function core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php Updates the 'help_search_unindexed_count' state variable.
SearchHelpSearch::updateTopicList function core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php Rebuilds the database table containing topics to be indexed.
SearchHelpSearch::__construct function core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php Constructs a \Drupal\Component\Plugin\PluginBase object.
SearchHooks::help function core/modules/search/src/Hook/SearchHooks.php Implements hook_help().
SearchInterface::getHelp function core/modules/search/src/Plugin/SearchInterface.php Returns the searching help.
SearchPluginBase::getHelp function core/modules/search/src/Plugin/SearchPluginBase.php Returns the searching help.
SearchUpdateTest::testSearchHelpInstall function core/modules/search/tests/src/Functional/Update/SearchUpdateTest.php Tests system_update_11401.
SearchUpdateUserTest::testSearchHelpInstall function core/modules/search/tests/src/Functional/Update/SearchUpdateUserTest.php Tests system_update_11402.
SearchUser::getHelp function core/modules/search/modules/search_user/src/Plugin/Search/SearchUser.php Returns the searching help.
search_help.info.yml file core/modules/search/modules/search_help/search_help.info.yml core/modules/search/modules/search_help/search_help.info.yml
search_help.install file core/modules/search/modules/search_help/search_help.install Install, update, and uninstall functions for the Search Help module.
search_help.schema.yml file core/modules/search/modules/search_help/config/schema/search_help.schema.yml core/modules/search/modules/search_help/config/schema/search_help.schema.yml
search_help_uninstall function core/modules/search/modules/search_help/search_help.install Implements hook_uninstall().
search_post_update_search_help_dependencies function core/modules/search/search.post_update.php Update config entity dependencies to the Search Help module, if necessary.
SerializationHooks::help function core/modules/serialization/src/Hook/SerializationHooks.php Implements hook_help().
SettingsTrayHooks::help function core/modules/settings_tray/src/Hook/SettingsTrayHooks.php Implements hook_help().
ShortcutHooks::help function core/modules/shortcut/src/Hook/ShortcutHooks.php Implements hook_help().

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