Same name in other branches

1. 9 core/lib/Drupal/Core/Form/FormBuilderInterface.php \Drupal\Core\Form\FormBuilderInterface::getForm()
2. 8.9.x core/lib/Drupal/Core/Form/FormBuilderInterface.php \Drupal\Core\Form\FormBuilderInterface::getForm()
3. 10 core/lib/Drupal/Core/Form/FormBuilderInterface.php \Drupal\Core\Form\FormBuilderInterface::getForm()

Gets a renderable form array.

This function should be used instead of self::buildForm() when $form_state is not needed (i.e., when initially rendering the form) and is often used as a menu callback.

Parameters

\Drupal\Core\Form\FormInterface|string $form_arg: The value must be one of the following:

• The name of a class that implements \Drupal\Core\Form\FormInterface.
• An instance of a class that implements \Drupal\Core\Form\FormInterface.

mixed ...$args: Additional arguments are passed on to the functions called by \Drupal::formBuilder()->getForm(), including the unique form constructor function. For example, the node preview form requires that a node object is passed in here when it is called. These are available to implementations of hook_form_alter() and hook_form_FORM_ID_alter() as the array $form_state->getBuildInfo()['args'].

Return value

array The form array.

See also

\Drupal\Core\Form\FormBuilderInterface::buildForm()

1 method overrides FormBuilderInterface::getForm()

FormBuilder::getForm in core/lib/Drupal/Core/Form/FormBuilder.php

Gets a renderable form array.

File

core/lib/Drupal/Core/Form/FormBuilderInterface.php, line 62

Class

FormBuilderInterface

Provides an interface for form building and processing.

Namespace

Drupal\Core\Form

Code

public function getForm($form_arg, mixed ...$args);

---