interface BaseFormIdInterface in Drupal 8

Provides an interface for a Form that has a base form ID.

This will become the $form_state->getBuildInfo()['base_form_id'] used to generate the name of hook_form_BASE_FORM_ID_alter().

Hierarchy

• interface \Drupal\Core\Form\FormInterface
  • interface \Drupal\Core\Form\BaseFormIdInterface

5 files declare their use of BaseFormIdInterface

AddFormBase.php in core/modules/media_library/src/Form/AddFormBase.php

ConfigTranslationFormBase.php in core/modules/config_translation/src/Form/ConfigTranslationFormBase.php

ConfigureBlockFormBase.php in core/modules/layout_builder/src/Form/ConfigureBlockFormBase.php

DeleteMultipleForm.php in core/lib/Drupal/Core/Entity/Form/DeleteMultipleForm.php

EntityFormInterface.php in core/lib/Drupal/Core/Entity/EntityFormInterface.php

File

core/lib/Drupal/Core/Form/BaseFormIdInterface.php, line 11

Namespace

Drupal\Core\Form

interface BaseFormIdInterface extends FormInterface {

  /**
   * Returns a string identifying the base form.
   *
   * @return string|null
   *   The string identifying the base form or NULL if this is not a base form.
   */
  public function getBaseFormId();

}

Members

Name	Modifiers	Type	Description	Overrides
BaseFormIdInterface::getBaseFormId	public	function	Returns a string identifying the base form.	5
FormInterface::buildForm	public	function	Form constructor.	179
FormInterface::getFormId	public	function	Returns a unique string identifying the form.	236
FormInterface::submitForm	public	function	Form submission handler.	192
FormInterface::validateForm	public	function	Form validation handler.	30