8.2.x EntityInterface.php public EntityInterface::toLink($text = NULL, $rel = 'canonical', array $options = [])
8.0.x EntityInterface.php public EntityInterface::toLink($text = NULL, $rel = 'canonical', array $options = [])
8.1.x EntityInterface.php public EntityInterface::toLink($text = NULL, $rel = 'canonical', array $options = [])
8.3.x EntityInterface.php public EntityInterface::toLink($text = NULL, $rel = 'canonical', array $options = [])

Generates the HTML for a link to this entity.

Parameters

string|null $text: (optional) The link text for the anchor tag as a translated string. If NULL, it will use the entity's label. Defaults to NULL.

string $rel: (optional) The link relationship type. Defaults to 'canonical'.

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

Return value

\Drupal\Core\Link A Link to the entity.

Throws

\Drupal\Core\Entity\EntityMalformedException

\Drupal\Core\Entity\Exception\UndefinedLinkTemplateException

2 methods override EntityInterface::toLink()
Entity::toLink in core/lib/Drupal/Core/Entity/Entity.php
Generates the HTML for a link to this entity.
ViewUI::toLink in core/modules/views_ui/src/ViewUI.php
Generates the HTML for a link to this entity.

File

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

Class

EntityInterface
Defines a common interface for all entity objects.

Namespace

Drupal\Core\Entity

Code

public function toLink($text = NULL, $rel = 'canonical', array $options = []);