function SearchPageForm::buildForm

Same name in other branches
  1. 8.9.x core/modules/search/src/Form/SearchPageForm.php \Drupal\search\Form\SearchPageForm::buildForm()
  2. 10 core/modules/search/src/Form/SearchPageForm.php \Drupal\search\Form\SearchPageForm::buildForm()
  3. 11.x core/modules/search/src/Form/SearchPageForm.php \Drupal\search\Form\SearchPageForm::buildForm()

Overrides FormInterface::buildForm

File

core/modules/search/src/Form/SearchPageForm.php, line 40

Class

SearchPageForm
Provides a search form for site wide search.

Namespace

Drupal\search\Form

Code

public function buildForm(array $form, FormStateInterface $form_state, SearchPageInterface $search_page = NULL) {
    $this->entity = $search_page;
    $plugin = $this->entity
        ->getPlugin();
    $form_state->set('search_page_id', $this->entity
        ->id());
    $form['basic'] = [
        '#type' => 'container',
        '#attributes' => [
            'class' => [
                'container-inline',
            ],
        ],
    ];
    $form['basic']['keys'] = [
        '#type' => 'search',
        '#title' => $this->t('Enter your keywords'),
        '#default_value' => $plugin->getKeywords(),
        '#size' => 30,
        '#maxlength' => 255,
    ];
    // processed_keys is used to coordinate keyword passing between other forms
    // that hook into the basic search form.
    $form['basic']['processed_keys'] = [
        '#type' => 'value',
        '#value' => '',
    ];
    $form['basic']['submit'] = [
        '#type' => 'submit',
        '#value' => $this->t('Search'),
    ];
    $form['help_link'] = [
        '#type' => 'link',
        '#url' => new Url('search.help_' . $this->entity
            ->id()),
        '#title' => $this->t('About searching'),
        '#options' => [
            'attributes' => [
                'class' => 'search-help-link',
            ],
        ],
    ];
    // Allow the plugin to add to or alter the search form.
    $plugin->searchFormAlter($form, $form_state);
    return $form;
}

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