You are here

public function EntityForm::getBaseFormId in Drupal 10

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Entity/EntityForm.php \Drupal\Core\Entity\EntityForm::getBaseFormId()
  2. 9 core/lib/Drupal/Core/Entity/EntityForm.php \Drupal\Core\Entity\EntityForm::getBaseFormId()

Returns a string identifying the base form.

Return value

string|null The string identifying the base form or NULL if this is not a base form.

Overrides BaseFormIdInterface::getBaseFormId

5 methods override EntityForm::getBaseFormId()
BookOutlineForm::getBaseFormId in core/modules/book/src/Form/BookOutlineForm.php
Returns a string identifying the base form.
ContentEntityConfirmFormBase::getBaseFormId in core/lib/Drupal/Core/Entity/ContentEntityConfirmFormBase.php
Returns a string identifying the base form.
DefaultsEntityForm::getBaseFormId in core/modules/layout_builder/src/Form/DefaultsEntityForm.php
Returns a string identifying the base form.
OverridesEntityForm::getBaseFormId in core/modules/layout_builder/src/Form/OverridesEntityForm.php
Returns a string identifying the base form.
SearchPageFormBase::getBaseFormId in core/modules/search/src/Form/SearchPageFormBase.php
Returns a string identifying the base form.

File

core/lib/Drupal/Core/Entity/EntityForm.php, line 63

Class

EntityForm
Base class for entity forms.

Namespace

Drupal\Core\Entity

Code

public function getBaseFormId() {

  // Assign ENTITYTYPE_form as base form ID to invoke corresponding
  // hook_form_alter(), #validate, #submit, and #theme callbacks, but only if
  // it is different from the actual form ID, since callbacks would be invoked
  // twice otherwise.
  $base_form_id = $this->entity
    ->getEntityTypeId() . '_form';
  if ($base_form_id == $this
    ->getFormId()) {
    $base_form_id = NULL;
  }
  return $base_form_id;
}