W3cubDocs

/Drupal 8

public function FormBuilderInterface::retrieveForm

public FormBuilderInterface::retrieveForm($form_id, FormStateInterface &$form_state)

Retrieves the structured array that defines a given form.

Parameters

string $form_id: The unique string identifying the desired form. If a function with that name exists, it is called to build the form array.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form, including the additional arguments to self::getForm() or self::submitForm() in the 'args' component of the array.

Return value

mixed|\Symfony\Component\HttpFoundation\Response

File

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

Class

FormBuilderInterface
Provides an interface for form building and processing.

Namespace

Drupal\Core\Form

Code

public function retrieveForm($form_id, FormStateInterface &$form_state);

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Form!FormBuilderInterface.php/function/FormBuilderInterface::retrieveForm/8.1.x