You are here

public function RouteMatchInterface::getParameter in Drupal 8

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Routing/RouteMatchInterface.php \Drupal\Core\Routing\RouteMatchInterface::getParameter()
  2. 10 core/lib/Drupal/Core/Routing/RouteMatchInterface.php \Drupal\Core\Routing\RouteMatchInterface::getParameter()

Returns the processed value of a named route parameter.

Raw URL parameters are processed by the parameter conversion system, which does operations such as converting entity ID parameters to fully-loaded entities. For example, the path node/12345 would have a raw node ID parameter value of 12345, while the processed parameter value would be the corresponding loaded node object.

Parameters

string $parameter_name: The parameter name.

Return value

mixed|null The parameter value. NULL if the route doesn't define the parameter or if the parameter value can't be determined from the request.

See also

\Drupal\Core\Routing\RouteMatchInterface::getRawParameter()

3 methods override RouteMatchInterface::getParameter()
CurrentRouteMatch::getParameter in core/lib/Drupal/Core/Routing/CurrentRouteMatch.php
Returns the processed value of a named route parameter.
NullRouteMatch::getParameter in core/lib/Drupal/Core/Routing/NullRouteMatch.php
Returns the processed value of a named route parameter.
RouteMatch::getParameter in core/lib/Drupal/Core/Routing/RouteMatch.php
Returns the processed value of a named route parameter.

File

core/lib/Drupal/Core/Routing/RouteMatchInterface.php, line 56

Class

RouteMatchInterface
Provides an interface for classes representing the result of routing.

Namespace

Drupal\Core\Routing

Code

public function getParameter($parameter_name);