function ConfirmFormBase::getDescription

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Form/ConfirmFormBase.php \Drupal\Core\Form\ConfirmFormBase::getDescription()
  2. 10 core/lib/Drupal/Core/Form/ConfirmFormBase.php \Drupal\Core\Form\ConfirmFormBase::getDescription()
  3. 8.9.x core/lib/Drupal/Core/Form/ConfirmFormBase.php \Drupal\Core\Form\ConfirmFormBase::getDescription()

Returns additional text to display as a description.

Return value

\Drupal\Core\StringTranslation\TranslatableMarkup The form description.

Overrides ConfirmFormInterface::getDescription

1 call to ConfirmFormBase::getDescription()
ConfirmFormBase::buildForm in core/lib/Drupal/Core/Form/ConfirmFormBase.php
Form constructor.
15 methods override ConfirmFormBase::getDescription()
BookRemoveForm::getDescription in core/modules/book/src/Form/BookRemoveForm.php
Returns additional text to display as a description.
ConfirmFormTestForm::getDescription in core/modules/system/tests/modules/form_test/src/ConfirmFormTestForm.php
Returns additional text to display as a description.
LayoutBuilderDisableForm::getDescription in core/modules/layout_builder/src/Form/LayoutBuilderDisableForm.php
Returns additional text to display as a description.
MenuLinkResetForm::getDescription in core/modules/menu_ui/src/Form/MenuLinkResetForm.php
Returns additional text to display as a description.
ModulesListConfirmForm::getDescription in core/modules/system/src/Form/ModulesListConfirmForm.php
Returns additional text to display as a description.

... See full list

File

core/lib/Drupal/Core/Form/ConfirmFormBase.php, line 13

Class

ConfirmFormBase
Provides a generic base class for a confirmation form.

Namespace

Drupal\Core\Form

Code

public function getDescription() {
  return $this->t('This action cannot be undone.');
}

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