function Url::setRouteParameter

Same name in other branches
  1. 9 core/lib/Drupal/Core/Url.php \Drupal\Core\Url::setRouteParameter()
  2. 8.9.x core/lib/Drupal/Core/Url.php \Drupal\Core\Url::setRouteParameter()
  3. 11.x core/lib/Drupal/Core/Url.php \Drupal\Core\Url::setRouteParameter()

Sets a specific route parameter.

Parameters

string $key: The key of the route parameter.

mixed $value: The route parameter.

Return value

$this

Throws

\UnexpectedValueException. If this is a URI with no corresponding route.

File

core/lib/Drupal/Core/Url.php, line 621

Class

Url
Defines an object that holds information about a URL.

Namespace

Drupal\Core

Code

public function setRouteParameter($key, $value) {
    if ($this->unrouted) {
        throw new \UnexpectedValueException('External URLs do not have route parameters.');
    }
    $this->routeParameters[$key] = $value;
    return $this;
}

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