1. 8.2.x core/modules/search/src/Annotation/SearchPlugin.php
  2. 8.0.x core/modules/search/src/Annotation/SearchPlugin.php
  3. 8.1.x core/modules/search/src/Annotation/SearchPlugin.php
  4. 8.3.x core/modules/search/src/Annotation/SearchPlugin.php

Namespace

Drupal\search\Annotation

File

core/modules/search/src/Annotation/SearchPlugin.php
View source
  1. <?php
  2. namespace Drupal\search\Annotation;
  3. use Drupal\Component\Annotation\Plugin;
  4. /**
  5. * Defines a SearchPlugin type annotation object.
  6. *
  7. * SearchPlugin classes define search types for the core Search module. Each
  8. * search type can be used to create search pages from the Search settings page.
  9. *
  10. * @see SearchPluginBase
  11. *
  12. * @ingroup search
  13. *
  14. * @Annotation
  15. */
  16. class SearchPlugin extends Plugin {
  17. /**
  18. * A unique identifier for the search plugin.
  19. *
  20. * @var string
  21. */
  22. public $id;
  23. /**
  24. * The title for the search page tab.
  25. *
  26. * @todo This will potentially be translated twice or cached with the wrong
  27. * translation until the search tabs are converted to local task plugins.
  28. *
  29. * @ingroup plugin_translatable
  30. *
  31. * @var \Drupal\Core\Annotation\Translation
  32. */
  33. public $title;
  34. }

Classes

Namesort descending Description
SearchPlugin Defines a SearchPlugin type annotation object.