function HelpTopicPluginInterface::toLink
Same name in other branches
- 9 core/modules/help_topics/src/HelpTopicPluginInterface.php \Drupal\help_topics\HelpTopicPluginInterface::toLink()
- 8.9.x core/modules/help_topics/src/HelpTopicPluginInterface.php \Drupal\help_topics\HelpTopicPluginInterface::toLink()
- 11.x core/modules/help/src/HelpTopicPluginInterface.php \Drupal\help\HelpTopicPluginInterface::toLink()
Returns a link for viewing the help topic.
Parameters
string|null $text: (optional) Link text to use for the link. If NULL, defaults to the topic title.
array $options: (optional) See \Drupal\Core\Routing\UrlGeneratorInterface::generateFromRoute() for the available options.
Return value
\Drupal\Core\Link A link object for viewing the topic.
1 method overrides HelpTopicPluginInterface::toLink()
- HelpTopicPluginBase::toLink in core/
modules/ help/ src/ HelpTopicPluginBase.php
File
-
core/
modules/ help/ src/ HelpTopicPluginInterface.php, line 76
Class
- HelpTopicPluginInterface
- Defines an interface for help topic plugin classes.
Namespace
Drupal\helpCode
public function toLink($text = NULL, array $options = []);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.