public function EntityInterface::toUrl in Drupal 8

Same name and namespace in other branches

1. 9 core/lib/Drupal/Core/Entity/EntityInterface.php \Drupal\Core\Entity\EntityInterface::toUrl()

Gets the URL object for the entity.

The entity must have an id already. Content entities usually get their IDs by saving them.

URI templates might be set in the links array in an annotation, for example:

links = {
  "canonical" = "/node/{node}",
  "edit-form" = "/node/{node}/edit",
  "version-history" = "/node/{node}/revisions"
}

or specified in a callback function set like:

uri_callback = "comment_uri",

If the path is not set in the links array, the uri_callback function is used for setting the path. If this does not exist and the link relationship type is canonical, the path is set using the default template: entity/entityType/id.

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

\Drupal\Core\Url The URL object.

Throws

\Drupal\Core\Entity\EntityMalformedException

\Drupal\Core\Entity\Exception\UndefinedLinkTemplateException

2 methods override EntityInterface::toUrl()

EntityBase::toUrl in core/lib/Drupal/Core/Entity/EntityBase.php

Gets the URL object for the entity.

ViewUI::toUrl in core/modules/views_ui/src/ViewUI.php

Gets the URL object for the entity.

File

core/lib/Drupal/Core/Entity/EntityInterface.php, line 154

Class

EntityInterface

Defines a common interface for all entity objects.

Namespace

Drupal\Core\Entity

Code

public function toUrl($rel = 'canonical', array $options = []);