Login Register

ConfirmFormBase::getDescription

public ConfirmFormBase::getDescription()

Returns additional text to display as a description.

Return value

string The form description.

Overrides ConfirmFormInterface::getDescription

File

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

Class

ConfirmFormBase: Provides an generic base class for a confirmation form.

Namespace

Drupal\Core\Form

Code

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

Links:

https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Form%21ConfirmFormBase.php/function/ConfirmFormBase%3A%3AgetDescription/8.2.x

doc_Drupal

2025-01-10 15:47:30

Comments

Leave a Comment

Please login to continue.

Popular Articles

ConfirmFormBase Provides an generic base class for a confirmation form. Hierarchy class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterf

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

ConfirmFormBase::buildForm public ConfirmFormBase::buildForm(array $form, FormStateInterface $form_state) Form constructor. Parameters array $form: An associative array contai

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

ConfirmFormBase::getFormName public ConfirmFormBase::getFormName() Returns the internal name used to refer to the confirmation item. Return value string The internal form name.