Search for interface

Title	Object type	File name	Summary
RouteObjectInterface::ROUTE_OBJECT	constant	core/lib/Drupal/Core/Routing/RouteObjectInterface.php	Key for the route object.
RouteProviderInterface	interface	core/lib/Drupal/Core/Routing/RouteProviderInterface.php	Defines the route provider interface.
RouteProviderInterface.php	file	core/lib/Drupal/Core/Routing/RouteProviderInterface.php
RouteProviderInterface::getAllRoutes	function	core/lib/Drupal/Core/Routing/RouteProviderInterface.php	Returns all the routes on the system.
RouteProviderInterface::getRouteByName	function	core/lib/Drupal/Core/Routing/RouteProviderInterface.php	Find the route using the provided route name.
RouteProviderInterface::getRouteCollectionForRequest	function	core/lib/Drupal/Core/Routing/RouteProviderInterface.php	Finds routes that may potentially match the request.
RouteProviderInterface::getRoutesByNames	function	core/lib/Drupal/Core/Routing/RouteProviderInterface.php	Find many routes by their names using the provided list of names.
RouteProviderInterface::getRoutesByPattern	function	core/lib/Drupal/Core/Routing/RouteProviderInterface.php	Get all routes which match a certain pattern.
RouteProviderInterface::reset	function	core/lib/Drupal/Core/Routing/RouteProviderInterface.php	Resets the route provider object.
SampleEntityGeneratorInterface	interface	core/modules/layout_builder/src/Entity/SampleEntityGeneratorInterface.php	Generates a sample entity.
SampleEntityGeneratorInterface.php	file	core/modules/layout_builder/src/Entity/SampleEntityGeneratorInterface.php
SampleEntityGeneratorInterface::delete	function	core/modules/layout_builder/src/Entity/SampleEntityGeneratorInterface.php	Deletes a sample entity for a given entity type and bundle.
SampleEntityGeneratorInterface::get	function	core/modules/layout_builder/src/Entity/SampleEntityGeneratorInterface.php	Gets a sample entity for a given entity type and bundle.
Search interface	group	core/modules/search/search.module	The Drupal search interface manages a global search mechanism.
SearchableHelpInterface	interface	core/modules/help_topics/src/SearchableHelpInterface.php	Provides an interface for a HelpSection plugin that also supports search.
SearchableHelpInterface	interface	core/modules/help/src/SearchableHelpInterface.php	Provides an interface for a HelpSection plugin that also supports search.
SearchableHelpInterface.php	file	core/modules/help/src/SearchableHelpInterface.php
SearchableHelpInterface.php	file	core/modules/help_topics/src/SearchableHelpInterface.php
SearchableHelpInterface::listSearchableTopics	function	core/modules/help/src/SearchableHelpInterface.php	Returns the IDs of topics that should be indexed for searching.
SearchableHelpInterface::renderTopicForSearch	function	core/modules/help/src/SearchableHelpInterface.php	Renders one topic for search indexing or search results.
SearchIndexingInterface	interface	core/modules/search/src/Plugin/SearchIndexingInterface.php	Defines an optional interface for SearchPlugin objects using an index.
SearchIndexingInterface.php	file	core/modules/search/src/Plugin/SearchIndexingInterface.php
SearchIndexingInterface::indexClear	function	core/modules/search/src/Plugin/SearchIndexingInterface.php	Clears the search index for this plugin.
SearchIndexingInterface::indexStatus	function	core/modules/search/src/Plugin/SearchIndexingInterface.php	Reports the status of indexing.
SearchIndexingInterface::markForReindex	function	core/modules/search/src/Plugin/SearchIndexingInterface.php	Marks the search index for reindexing for this plugin.
SearchIndexingInterface::updateIndex	function	core/modules/search/src/Plugin/SearchIndexingInterface.php	Updates the search index for this plugin.
SearchIndexInterface	interface	core/modules/search/src/SearchIndexInterface.php	Provides search index management functions.
SearchIndexInterface.php	file	core/modules/search/src/SearchIndexInterface.php
SearchIndexInterface::clear	function	core/modules/search/src/SearchIndexInterface.php	Clears either a part of, or the entire search index.
SearchIndexInterface::index	function	core/modules/search/src/SearchIndexInterface.php	Updates the full-text search index for a particular item.
SearchIndexInterface::markForReindex	function	core/modules/search/src/SearchIndexInterface.php	Changes the timestamp on indexed items to 'now' to force reindexing.
SearchIndexInterface::updateWordWeights	function	core/modules/search/src/SearchIndexInterface.php	Updates the {search_total} database table.
SearchInterface	interface	core/modules/search/src/Plugin/SearchInterface.php	Defines a common interface for all SearchPlugin objects.
SearchInterface.php	file	core/modules/search/src/Plugin/SearchInterface.php
SearchInterface::buildResults	function	core/modules/search/src/Plugin/SearchInterface.php	Executes the search and builds render arrays for the result items.
SearchInterface::buildSearchUrlQuery	function	core/modules/search/src/Plugin/SearchInterface.php	Builds the URL GET query parameters array for search.
SearchInterface::execute	function	core/modules/search/src/Plugin/SearchInterface.php	Executes the search.
SearchInterface::getAttributes	function	core/modules/search/src/Plugin/SearchInterface.php	Returns the currently set attributes (from the request).
SearchInterface::getHelp	function	core/modules/search/src/Plugin/SearchInterface.php	Returns the searching help.
SearchInterface::getKeywords	function	core/modules/search/src/Plugin/SearchInterface.php	Returns the currently set keywords of the plugin instance.
SearchInterface::getParameters	function	core/modules/search/src/Plugin/SearchInterface.php	Returns the current parameters set using setSearch().
SearchInterface::getType	function	core/modules/search/src/Plugin/SearchInterface.php	Returns the search index type this plugin uses.
SearchInterface::isSearchExecutable	function	core/modules/search/src/Plugin/SearchInterface.php	Verifies if the values set via setSearch() are valid and sufficient.
SearchInterface::searchFormAlter	function	core/modules/search/src/Plugin/SearchInterface.php	Alters the search form when being built for a given plugin.
SearchInterface::setSearch	function	core/modules/search/src/Plugin/SearchInterface.php	Sets the keywords, parameters, and attributes to be used by execute().
SearchInterface::suggestedTitle	function	core/modules/search/src/Plugin/SearchInterface.php	Provides a suggested title for a page of search results.
SearchInterface::usesAdminTheme	function	core/modules/search/src/Plugin/SearchInterface.php	Returns whether or not search results should be displayed in admin theme.
SearchPageInterface	interface	core/modules/search/src/SearchPageInterface.php	Provides an interface defining a search page entity.
SearchPageInterface.php	file	core/modules/search/src/SearchPageInterface.php
SearchPageInterface::getPath	function	core/modules/search/src/SearchPageInterface.php	Returns the path for the search.

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