/Drupal 8

interface ContextualLinkInterface

Defines a contextual link plugin.

Contextual links by default are in the module_name.links.contextual.yml file. These YAML files contain a list of contextual link plugin definitions, keyed by the plugin ID. Each definition must define a route_name and a group and might define title, options, and weight. See the getter methods on this interface for an explanation of each.


Related topics

Menu system
Define the navigation menus, local actions and tasks, and contextual links.


core/lib/Drupal/Core/Menu/ContextualLinkInterface.php, line 16




Name Modifiers Type Description
ContextualLinkInterface::getGroup public function Returns the group this contextual link should be rendered in.
ContextualLinkInterface::getOptions public function Returns the link options passed to the link generator.
ContextualLinkInterface::getRouteName public function Returns the route name of the contextual link.
ContextualLinkInterface::getTitle public function Returns the localized title to be shown for this contextual link.
ContextualLinkInterface::getWeight public function Returns the weight of the contextual link.

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.