public function OutboundPathProcessorInterface::processOutbound in Drupal 10

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/PathProcessor/OutboundPathProcessorInterface.php \Drupal\Core\PathProcessor\OutboundPathProcessorInterface::processOutbound()
2. 9 core/lib/Drupal/Core/PathProcessor/OutboundPathProcessorInterface.php \Drupal\Core\PathProcessor\OutboundPathProcessorInterface::processOutbound()

Processes the outbound path.

Parameters

string $path: The path to process, with a leading slash.

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.
• 'route': The route object for the given path. It will be set by \Drupal\Core\Routing\UrlGenerator::generateFromRoute().

\Symfony\Component\HttpFoundation\Request $request: The HttpRequest object representing the current request.

\Drupal\Core\Render\BubbleableMetadata $bubbleable_metadata: (optional) Object to collect path processors' bubbleable metadata.

Return value

string The processed path.

3 methods override OutboundPathProcessorInterface::processOutbound()

AliasPathProcessor::processOutbound in core/modules/path_alias/src/PathProcessor/AliasPathProcessor.php

Processes the outbound path.

PathProcessorLanguage::processOutbound in core/modules/language/src/HttpKernel/PathProcessorLanguage.php

Processes the outbound path.

PathProcessorTest::processOutbound in core/modules/system/tests/modules/url_alter_test/src/PathProcessorTest.php

Processes the outbound path.

File

core/lib/Drupal/Core/PathProcessor/OutboundPathProcessorInterface.php, line 48

Class

OutboundPathProcessorInterface

Defines an interface for classes that process the outbound path.

Namespace

Drupal\Core\PathProcessor

Code

public function processOutbound($path, &$options = [], Request $request = NULL, BubbleableMetadata $bubbleable_metadata = NULL);