public function UrlGeneratorInterface::generateFromRoute in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Routing/UrlGeneratorInterface.php \Drupal\Core\Routing\UrlGeneratorInterface::generateFromRoute()

Generates a URL or path for a specific route based on the given parameters.

Parameters that reference placeholders in the route pattern will be substituted for them in the pattern. Extra params are added as query strings to the URL.

@internal Should not be used in user code. Use \Drupal\Core\Url instead.

Parameters

string|\Symfony\Component\Routing\Route $name: The route name or a route object.

array $parameters: An associative array of parameter names and values.

array $options: (optional) An associative array of additional options, with the following elements:

• 'query': An array of query key/value-pairs (without any URL-encoding) to append to the URL.
• 'fragment': A fragment identifier (named anchor) to append to the URL. Do not include the leading '#' character.
• 'absolute': Defaults to FALSE. Whether to force the output to be an absolute link (beginning with http:). Useful for links that will be displayed outside the site, such as in an RSS feed.
• 'language': An optional language object used to look up the alias for the URL. If $options['language'] is omitted, it defaults to the current language for the language type LanguageInterface::TYPE_URL.
• 'https': Whether this URL should point to a secure location. If not defined, the current scheme is used, so the user stays on HTTP or HTTPS respectively. TRUE enforces HTTPS and FALSE enforces HTTP.
• 'base_url': Only used internally by a path processor, for example, to modify the base URL when a language dependent URL requires so.
• 'prefix': Only used internally, to modify the path when a language dependent URL requires so.

bool $collect_bubbleable_metadata: (optional) Defaults to FALSE. When TRUE, both the generated URL and its associated bubbleable metadata are returned.

Return value

string|\Drupal\Core\GeneratedUrl The generated URL for the given route. When $collect_bubbleable_metadata is TRUE, a GeneratedUrl object is returned, containing the generated URL plus bubbleable metadata.

Throws

\Symfony\Component\Routing\Exception\RouteNotFoundException Thrown when the named route does not exist.

\Symfony\Component\Routing\Exception\MissingMandatoryParametersException Thrown when some parameters are missing that are mandatory for the route.

\Symfony\Component\Routing\Exception\InvalidParameterException Thrown when a parameter value for a placeholder is not correct because it does not match the requirement.

3 methods override UrlGeneratorInterface::generateFromRoute()

MetadataBubblingUrlGenerator::generateFromRoute in core/lib/Drupal/Core/Render/MetadataBubblingUrlGenerator.php

Generates a URL or path for a specific route based on the given parameters.

SupernovaGenerator::generateFromRoute in core/modules/help/tests/modules/help_test/src/SupernovaGenerator.php

Generates a URL or path for a specific route based on the given parameters.

UrlGenerator::generateFromRoute in core/lib/Drupal/Core/Routing/UrlGenerator.php

Generates a URL or path for a specific route based on the given parameters.

File

core/lib/Drupal/Core/Routing/UrlGeneratorInterface.php, line 81

Class

UrlGeneratorInterface

Defines an interface for generating a url from a route or system path.

Namespace

Drupal\Core\Routing

Code

public function generateFromRoute($name, $parameters = [], $options = [], $collect_bubbleable_metadata = FALSE);