class SearchPlugin
Same name and namespace in other branches
- 11.x core/modules/search/src/Annotation/SearchPlugin.php \Drupal\search\Annotation\SearchPlugin
Defines a SearchPlugin type annotation object.
SearchPlugin classes define search types for the core Search module. Each search type can be used to create search pages from the Search settings page.
Hierarchy
- class \Drupal\Component\Annotation\Plugin extends \Drupal\Component\Annotation\AnnotationInterface
- class \Drupal\search\Annotation\SearchPlugin implements \Drupal\Component\Annotation\Plugin
Expanded class hierarchy of SearchPlugin
See also
SearchPluginBase
Related topics
3 classes are annotated with SearchPlugin
- NodeSearch in core/
modules/ node/ src/ Plugin/ Search/ NodeSearch.php - Handles searching for node entities using the Search module index.
- SearchExtraTypeSearch in core/
modules/ search/ tests/ modules/ search_extra_type/ src/ Plugin/ Search/ SearchExtraTypeSearch.php - Executes a dummy keyword search.
- UserSearch in core/
modules/ user/ src/ Plugin/ Search/ UserSearch.php - Executes a keyword search for users against the {users} database table.
File
-
core/
modules/ search/ src/ Annotation/ SearchPlugin.php, line 19
Namespace
Drupal\search\AnnotationView source
class SearchPlugin extends Plugin {
/**
* A unique identifier for the search plugin.
*
* @var string
*/
public $id;
/**
* The title for the search page tab.
*
* @todo This will potentially be translated twice or cached with the wrong
* translation until the search tabs are converted to local task plugins.
*
* @ingroup plugin_translatable
*
* @var \Drupal\Core\Annotation\Translation
*/
public $title;
/**
* Whether or not search results should be displayed in admin theme.
*
* @var bool
*/
public $use_admin_theme = FALSE;
}Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.