function Url::getUri

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Url.php \Drupal\Core\Url::getUri()
  2. 10 core/lib/Drupal/Core/Url.php \Drupal\Core\Url::getUri()
  3. 8.9.x core/lib/Drupal/Core/Url.php \Drupal\Core\Url::getUri()

Returns the URI value for this Url object.

Only to be used if self::$unrouted is TRUE.

Return value

string A URI not connected to a route. May be an external URL.

Throws

\UnexpectedValueException Thrown when the URI was requested for a routed URL.

File

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

Class

Url
Defines an object that holds information about a URL.

Namespace

Drupal\Core

Code

public function getUri() {
  if (!$this->unrouted) {
    throw new \UnexpectedValueException('This URL has a Drupal route, so the canonical form is not a URI.');
  }
  return $this->uri;
}

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