public FormBuilder::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
Overrides FormBuilderInterface::retrieveForm
File
- core/lib/Drupal/Core/Form/FormBuilder.php, line 487
Class
- FormBuilder
- Provides form building and processing.
Namespace
Drupal\Core\Form
Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 | public function retrieveForm($form_id, FormStateInterface &$form_state) { // Record the $form_id. $form_state->addBuildInfo('form_id', $form_id); // We save two copies of the incoming arguments: one for modules to use // when mapping form ids to constructor functions, and another to pass to // the constructor function itself. $build_info = $form_state->getBuildInfo(); $args = $build_info['args']; $callback = [$form_state->getFormObject(), 'buildForm']; $form = array(); // Assign a default CSS class name based on $form_id. // This happens here and not in self::prepareForm() in order to allow the // form constructor function to override or remove the default class. $form['#attributes']['class'][] = Html::getClass($form_id); // Same for the base form ID, if any. if (isset($build_info['base_form_id'])) { $form['#attributes']['class'][] = Html::getClass($build_info['base_form_id']); } // We need to pass $form_state by reference in order for forms to modify it, // since call_user_func_array() requires that referenced variables are // passed explicitly. $args = array_merge(array($form, &$form_state), $args); $form = call_user_func_array($callback, $args); // If the form returns a response, skip subsequent page construction by // throwing an exception. // @see Drupal\Core\EventSubscriber\EnforcedFormResponseSubscriber // // @todo Exceptions should not be used for code flow control. However, the // Form API currently allows any form builder functions to return a // response. if ($form instanceof Response) { throw new EnforcedResponseException($form); } $form['#form_id'] = $form_id; return $form;} |
Please login to continue.