function Url::toString

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

Generates the string URL representation for this Url object.

For an external URL, the string will contain the input plus any query string or fragment specified by the options array.

If this Url object was constructed from a Drupal route or from an internal URI (URIs using the internal:, base:, or entity: schemes), the returned string will either be a relative URL like /node/1 or an absolute URL like depending on the options array, plus any specified query string or fragment.


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 A string URL. When $collect_bubbleable_metadata is TRUE, a GeneratedUrl object is returned, containing the generated URL plus bubbleable metadata.


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


Defines an object that holds information about a URL.




public function toString($collect_bubbleable_metadata = FALSE) {
    if ($this->unrouted) {
        return $this->unroutedUrlAssembler()
            ->assemble($this->getUri(), $this->getOptions(), $collect_bubbleable_metadata);
    return $this->urlGenerator()
        ->generateFromRoute($this->getRouteName(), $this->getRouteParameters(), $this->getOptions(), $collect_bubbleable_metadata);

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