class Search

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

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

Usage example:

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

Plugin annotation

@FormElement("search");

Hierarchy

Expanded class hierarchy of Search

See also

\Drupal\Core\Render\Element\Textfield

103 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.bartik_search.yml in core/profiles/standard/config/optional/block.block.bartik_search.yml
core/profiles/standard/config/optional/block.block.bartik_search.yml
block.block.bartik_search.yml in core/profiles/standard/config/optional/block.block.bartik_search.yml
core/profiles/standard/config/optional/block.block.bartik_search.yml
block.block.claro_help_search.yml in core/modules/help_topics/config/optional/block.block.claro_help_search.yml
core/modules/help_topics/config/optional/block.block.claro_help_search.yml

... See full list

12 #type uses of Search
BlockLibraryController::listBlocks in core/modules/block/src/Controller/BlockLibraryController.php
Shows a list of blocks that can be added to a theme's layout.
ChooseBlockController::build in core/modules/layout_builder/src/Controller/ChooseBlockController.php
Provides the UI for choosing a new block.
ConfigTranslationEntityListBuilder::render in core/modules/config_translation/src/Controller/ConfigTranslationEntityListBuilder.php
Builds the entity listing as renderable array for table.html.twig.
FormTest::testRequiredFields in core/modules/system/tests/src/Functional/Form/FormTest.php
Check several empty values for required forms elements.
hook_toolbar in core/modules/toolbar/toolbar.api.php
Add items to the toolbar menu.

... See full list

File

core/lib/Drupal/Core/Render/Element/Search.php, line 22

Namespace

Drupal\Core\Render\Element
View source
class Search extends FormElement {
    
    /**
     * {@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
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
FormElement::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback 16
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
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
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.