Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. HelpTopicPluginInterface.php

function 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
Returns a link for viewing the help topic.

File

core/modules/help/src/HelpTopicPluginInterface.php, line 76

Class

HelpTopicPluginInterface
Defines an interface for help topic plugin classes.

Namespace

Drupal\help

Code

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

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal