8.2.x Entity.php public Entity::url($rel = 'canonical', $options = array())
8.0.x Entity.php public Entity::url($rel = 'canonical', $options = array())
8.1.x Entity.php public Entity::url($rel = 'canonical', $options = array())
8.3.x Entity.php public Entity::url($rel = 'canonical', $options = [])

Gets the public URL for this entity.

Parameters

string $rel: The link relationship type, for example: canonical or edit-form.

array $options: See \Drupal\Core\Routing\UrlGeneratorInterface::generateFromRoute() for the available options.

Return value

string The URL for this entity.

Overrides EntityInterface::url

Deprecated

in Drupal 8.0.0, intended to be removed in Drupal 9.0.0 Please use toUrl() instead.

See also

\Drupal\Core\Entity\EntityInterface::toUrl

1 call to Entity::url()
ConfigEntityBase::url in core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php
Gets the public URL for this entity.
2 methods override Entity::url()
ConfigEntityBase::url in core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php
Gets the public URL for this entity.
File::url in core/modules/file/src/Entity/File.php

File

core/lib/Drupal/Core/Entity/Entity.php, line 278

Class

Entity
Defines a base entity class.

Namespace

Drupal\Core\Entity

Code

public function url($rel = 'canonical', $options = array()) {
  // While self::toUrl() will throw an exception if the entity has no id,
  // the expected result for a URL is always a string.
  if ($this->id() === NULL || !$this->hasLinkTemplate($rel)) {
    return '';
  }

  $uri = $this->toUrl($rel);
  $options += $uri->getOptions();
  $uri->setOptions($options);
  return $uri->toString();
}