function EntityInterface::toLink
Same name in other branches
- 9 core/lib/Drupal/Core/Entity/EntityInterface.php \Drupal\Core\Entity\EntityInterface::toLink()
- 8.9.x core/lib/Drupal/Core/Entity/EntityInterface.php \Drupal\Core\Entity\EntityInterface::toLink()
- 11.x core/lib/Drupal/Core/Entity/EntityInterface.php \Drupal\Core\Entity\EntityInterface::toLink()
Generates the HTML for a link to this entity.
Parameters
string|null|array|\Drupal\Component\Render\MarkupInterface $text: (optional) The link text for the anchor tag as a translated string or render array. 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()
- EntityBase::toLink in core/
lib/ Drupal/ Core/ Entity/ EntityBase.php - 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 156
Class
- EntityInterface
- Defines a common interface for all entity objects.
Namespace
Drupal\Core\EntityCode
public function toLink($text = NULL, $rel = 'canonical', array $options = []);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.