ReindexConfirm::getDescription

public ReindexConfirm::getDescription()

Returns additional text to display as a description.

Return value

string The form description.

Overrides ConfirmFormBase::getDescription

File

core/modules/search/src/Form/ReindexConfirm.php, line 31

Class

ReindexConfirm: Provides the search reindex confirmation form.

Namespace

Drupal\search\Form

Code

public function getDescription() {
  return $this->t("This will re-index content in the search indexes of all active search pages. Searching will continue to work, but new content won't be indexed until all existing content has been re-indexed. This action cannot be undone.");
}

Links:

https://api.drupal.org/api/drupal/core%21modules%21search%21src%21Form%21ReindexConfirm.php/function/ReindexConfirm%3A%3AgetDescription/8.2.x

doc_Drupal

2016-10-29 09:37:19

Comments

Popular Articles

ReindexConfirm Provides the search reindex confirmation form. Hierarchy class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses

ReindexConfirm::getFormId public ReindexConfirm::getFormId() Returns a unique string identifying the form. Return value string The unique string identifying the form. Overrid

ReindexConfirm::getConfirmText public ReindexConfirm::getConfirmText() Returns a caption for the button that confirms the action. Return value string The form confirmation text. O

ReindexConfirm::submitForm public ReindexConfirm::submitForm(array &$form, FormStateInterface $form_state) Form submission handler. Parameters array $form: An associative

ReindexConfirm::getCancelText public ReindexConfirm::getCancelText() Returns a caption for the link which cancels the action. Return value string The form cancellation text. Over