class Search

Same name in this branch
  1. 10 core/modules/search/src/Plugin/views/filter/Search.php \Drupal\search\Plugin\views\filter\Search
  2. 10 core/modules/search/src/Plugin/views/argument/Search.php \Drupal\search\Plugin\views\argument\Search
  3. 10 core/lib/Drupal/Core/Render/Element/Search.php \Drupal\Core\Render\Element\Search
Same name in other branches
  1. 9 core/modules/search/src/Plugin/views/filter/Search.php \Drupal\search\Plugin\views\filter\Search
  2. 9 core/modules/search/src/Plugin/views/argument/Search.php \Drupal\search\Plugin\views\argument\Search
  3. 9 core/lib/Drupal/Core/Render/Element/Search.php \Drupal\Core\Render\Element\Search
  4. 8.9.x core/modules/search/src/Plugin/views/filter/Search.php \Drupal\search\Plugin\views\filter\Search
  5. 8.9.x core/modules/search/src/Plugin/views/argument/Search.php \Drupal\search\Plugin\views\argument\Search
  6. 8.9.x core/lib/Drupal/Core/Render/Element/Search.php \Drupal\Core\Render\Element\Search
  7. 11.x core/modules/search/src/Plugin/views/filter/Search.php \Drupal\search\Plugin\views\filter\Search
  8. 11.x core/modules/search/src/Plugin/views/argument/Search.php \Drupal\search\Plugin\views\argument\Search
  9. 11.x core/lib/Drupal/Core/Render/Element/Search.php \Drupal\Core\Render\Element\Search
  10. 11.x core/modules/search/src/Attribute/Search.php \Drupal\search\Attribute\Search

Defines a Search type attribute for plugin discovery.

Search classes define search types for the core Search module. Each search type can be used to create search pages from the Search settings page.

Attributes

#[\Attribute(\Attribute::TARGET_CLASS)]
#[ViewsFilter("search_keywords")]
#[ViewsArgument(id: 'search')]
#[FormElement('search')]

Hierarchy

  • class \Drupal\search\Attribute\Search extends \Drupal\Component\Plugin\Attribute\Plugin

Expanded class hierarchy of Search

See also

SearchPluginBase

Related topics

Search interface
The Drupal search interface manages a global search mechanism.
5 files declare their use of Search
HelpSearch.php in core/modules/help/src/Plugin/Search/HelpSearch.php
NodeSearch.php in core/modules/node/src/Plugin/Search/NodeSearch.php
SearchExtraTypeSearch.php in core/modules/search/tests/modules/search_extra_type/src/Plugin/Search/SearchExtraTypeSearch.php
SearchPluginManager.php in core/modules/search/src/SearchPluginManager.php
UserSearch.php in core/modules/user/src/Plugin/Search/UserSearch.php
105 string references to 'Search'
AddHandler::buildForm in core/modules/views_ui/src/Form/Ajax/AddHandler.php
Form constructor.
AjaxFormCacheTest::testBlockForms in core/tests/Drupal/FunctionalJavascriptTests/Ajax/AjaxFormCacheTest.php
Tests AJAX forms in blocks.
block.block.claro_help_search.yml in core/modules/help/config/optional/block.block.claro_help_search.yml
core/modules/help/config/optional/block.block.claro_help_search.yml
block.block.olivero_search_form_narrow.yml in core/themes/olivero/config/optional/block.block.olivero_search_form_narrow.yml
core/themes/olivero/config/optional/block.block.olivero_search_form_narrow.yml
block.block.olivero_search_form_wide.yml in core/themes/olivero/config/optional/block.block.olivero_search_form_wide.yml
core/themes/olivero/config/optional/block.block.olivero_search_form_wide.yml

... See full list

File

core/modules/search/src/Attribute/Search.php, line 18

Namespace

Drupal\search\Attribute
View source 
class Search extends Plugin {
    
    /**
     * Constructs a Search attribute.
     *
     * @param string $id
     *   The plugin ID.
     * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $title
     *   The title for the search page tab.
     * @param bool $use_admin_theme
     *   Whether search results should be displayed in admin theme or not.
     * @param class-string|null $deriver
     *   (optional) The deriver class.
     */
    public function __construct(string $id, ?TranslatableMarkup $title = NULL, bool $use_admin_theme = FALSE, ?string $deriver = NULL) {
    }

}

Members

Title Modifiers Object type Summary
Search::__construct public function Constructs a Search attribute.

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