class SearchPlugin in Drupal 9

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 implements AnnotationInterface
  • class \Drupal\search\Annotation\SearchPlugin

See also

SearchPluginBase

Related topics

Annotations

Annotations for class discovery and metadata description.

Search interface

The Drupal search interface manages a global search mechanism.

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\Annotation

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;

}

Members

Name	Modifiers	Type	Description	Overrides
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider	1
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2
SearchPlugin::$id	public	property	A unique identifier for the search plugin.
SearchPlugin::$title	public	property	The title for the search page tab.
SearchPlugin::$use_admin_theme	public	property	Whether or not search results should be displayed in admin theme.