1. 8.5.x core/modules/search/src/Form/SearchPageForm.php SearchPageForm
  2. 8.0.x core/modules/search/src/Form/SearchPageForm.php SearchPageForm
  3. 8.1.x core/modules/search/src/Form/SearchPageForm.php SearchPageForm
  4. 8.2.x core/modules/search/src/Form/SearchPageForm.php SearchPageForm
  5. 8.3.x core/modules/search/src/Form/SearchPageForm.php SearchPageForm
  6. 8.4.x core/modules/search/src/Form/SearchPageForm.php SearchPageForm
  7. 8.6.x core/modules/search/src/Form/SearchPageForm.php SearchPageForm

Provides a search form for site wide search.

Search plugins can define method searchFormAlter() to alter the form. If they have additional or substitute fields, they will need to override the form submit, making sure to redirect with a GET parameter of 'keys' included, to trigger the search being processed by the controller, and adding in any additional query parameters they need to execute search.


Expanded class hierarchy of SearchPageForm

1 file declares its use of SearchPageForm
SearchController.php in core/modules/search/src/Controller/SearchController.php


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


View source
class SearchPageForm extends FormBase {

   * The search page entity.
   * @var \Drupal\search\SearchPageInterface
  protected $entity;

   * {@inheritdoc}
  public function getFormId() {
    return 'search_form';

   * {@inheritdoc}
  public function buildForm(array $form, FormStateInterface $form_state, SearchPageInterface $search_page = NULL) {
    $this->entity = $search_page;
    $plugin = $this->entity
      ->set('search_page_id', $this->entity
    $form['basic'] = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
    $form['basic']['keys'] = [
      '#type' => 'search',
      '#title' => $this
        ->t('Enter your keywords'),
      '#default_value' => $plugin
      '#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
    $form['help_link'] = [
      '#type' => 'link',
      '#url' => new Url('search.help_' . $this->entity
      '#title' => $this
        ->t('Search help'),
      '#options' => [
        'attributes' => [
          'class' => 'search-help-link',

    // Allow the plugin to add to or alter the search form.
      ->searchFormAlter($form, $form_state);
    return $form;

   * {@inheritdoc}
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Redirect to the search page with keywords in the GET parameters.
    // Plugins with additional search parameters will need to provide their
    // own form submit handler to replace this, so they can put their values
    // into the GET as well. If so, make sure to put 'keys' into the GET
    // parameters so that the search results generation is triggered.
    $query = $this->entity
    $route = 'search.view_' . $form_state
      ->setRedirect($route, [], [
      'query' => $query,



Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Prevents serializing any properties.
DependencySerializationTrait::__wakeup public function
FormBase::$configFactory protected property The config factory.
FormBase::$requestStack protected property The request stack.
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form.
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm
LinkGeneratorTrait::$linkGenerator protected property The link generator.
LinkGeneratorTrait::getLinkGenerator protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service.
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
SearchPageForm::$entity protected property The search page entity.
SearchPageForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
SearchPageForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SearchPageForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
StringTranslationTrait::$stringTranslation protected property The string translation service.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator protected function Returns the URL generator service.
UrlGeneratorTrait::redirect protected function Returns a redirect response object for the specified route.
UrlGeneratorTrait::setUrlGenerator public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.