BaseFormIdInterface.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Form/BaseFormIdInterface.php
  2. 8.9.x core/lib/Drupal/Core/Form/BaseFormIdInterface.php
  3. 10 core/lib/Drupal/Core/Form/BaseFormIdInterface.php

Namespace

Drupal\Core\Form

File

core/lib/Drupal/Core/Form/BaseFormIdInterface.php

View source
<?php

namespace Drupal\Core\Form;


/**
 * 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().
 */
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();

}

Interfaces

Title Deprecated Summary
BaseFormIdInterface Provides an interface for a Form that has a base form ID.

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