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/modules/search/src/Attribute/Search.php \Drupal\search\Attribute\Search
Same name and namespace 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

Provides an HTML5 input element with type of "search".

Usage example:

$form['search'] = [
  '#type' => 'search',
  '#title' => $this->t('Search'),
];

Hierarchy

Expanded class hierarchy of Search

See also

\Drupal\Core\Render\Element\Textfield

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/lib/Drupal/Core/Render/Element/Search.php, line 21

Namespace

Drupal\Core\Render\Element
View source
class Search extends FormElementBase {
  
  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = static::class;
    return [
      '#input' => TRUE,
      '#size' => 60,
      '#maxlength' => 128,
      '#autocomplete_route_name' => FALSE,
      '#process' => [
        [
          $class,
          'processAutocomplete',
        ],
        [
          $class,
          'processAjaxForm',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderSearch',
        ],
      ],
      '#theme' => 'input__search',
      '#theme_wrappers' => [
        'form_element',
      ],
    ];
  }
  
  /**
   * Prepares a #type 'search' render element for input.html.twig.
   *
   * @param array $element
   *   An associative array containing the properties of the element.
   *   Properties used: #title, #value, #description, #size, #maxlength,
   *   #placeholder, #required, #attributes.
   *
   * @return array
   *   The $element with prepared variables ready for input.html.twig.
   */
  public static function preRenderSearch($element) {
    $element['#attributes']['type'] = 'search';
    Element::setAttributes($element, [
      'id',
      'name',
      'value',
      'size',
      'maxlength',
      'placeholder',
    ]);
    static::setAttributes($element, [
      'form-search',
    ]);
    return $element;
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
FormElementBase::processAutocomplete public static function Adds autocomplete functionality to elements. 1
FormElementBase::processPattern public static function #process callback for #pattern form element property. 1
FormElementBase::validatePattern public static function #element_validate callback for #pattern form element property. 1
FormElementBase::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback 17
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
RenderElementBase::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript. 2
RenderElementBase::preRenderGroup public static function Adds members of this group as actual elements for rendering. 2
RenderElementBase::processAjaxForm public static function Form element processing handler for the #ajax form property. 3
RenderElementBase::processGroup public static function Arranges elements into groups. 2
RenderElementBase::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes 2
Search::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
Search::preRenderSearch public static function Prepares a #type 'search' render element for input.html.twig.

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