Search.php

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

Namespace

Drupal\search\Attribute

File

core/modules/search/src/Attribute/Search.php

View source
<?php

namespace Drupal\search\Attribute;

use Drupal\Component\Plugin\Attribute\Plugin;
use Drupal\Core\StringTranslation\TranslatableMarkup;

/**
 * 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.
 *
 * @see SearchPluginBase
 *
 * @ingroup search
 */
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) {
    }

}

Classes

Title Deprecated Summary
Search Defines a Search type attribute for plugin discovery.

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