function FormController::getFormArgument

Same name in other branches
  1. 9 core/lib/Drupal/Core/Controller/FormController.php \Drupal\Core\Controller\FormController::getFormArgument()
  2. 8.9.x core/lib/Drupal/Core/Controller/FormController.php \Drupal\Core\Controller\FormController::getFormArgument()
  3. 10 core/lib/Drupal/Core/Controller/FormController.php \Drupal\Core\Controller\FormController::getFormArgument()

Extracts the form argument string from a request.

Depending on the type of form the argument string may be stored in a different request attribute.

One example of a route definition is given below.

defaults:
_form:
Drupal\example\Form\ExampleForm;

Parameters

\Drupal\Core\Routing\RouteMatchInterface $route_match: The route match object from which to extract a form definition string.

Return value

string The form definition string.

1 call to FormController::getFormArgument()
FormController::getContentResult in core/lib/Drupal/Core/Controller/FormController.php
Invokes the form and returns the result.
5 methods override FormController::getFormArgument()
HtmlEntityFormController::getFormArgument in core/lib/Drupal/Core/Entity/HtmlEntityFormController.php
Extracts the form argument string from a request.
HtmlFormController::getFormArgument in core/lib/Drupal/Core/Controller/HtmlFormController.php
Extracts the form argument string from a request.
LayoutBuilderDecorationTestHtmlEntityFormController::getFormArgument in core/modules/layout_builder/tests/modules/layout_builder_decoration_test/src/Controller/LayoutBuilderDecorationTestHtmlEntityFormController.php
Extracts the form argument string from a request.
LayoutBuilderHtmlEntityFormController::getFormArgument in core/modules/layout_builder/src/Controller/LayoutBuilderHtmlEntityFormController.php
Extracts the form argument string from a request.
WorkspacesHtmlEntityFormController::getFormArgument in core/modules/workspaces/src/Controller/WorkspacesHtmlEntityFormController.php
Extracts the form argument string from a request.

File

core/lib/Drupal/Core/Controller/FormController.php, line 94

Class

FormController
Common base class for form interstitial controllers.

Namespace

Drupal\Core\Controller

Code

protected abstract function getFormArgument(RouteMatchInterface $route_match);

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