ContextualLinkInterface
interface ContextualLinkInterface (View source)
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.
Methods
Returns the localized title to be shown for this contextual link.
Returns the route name of the contextual link.
Returns the group this contextual link should be rendered in.
Returns the link options passed to the link generator.
Returns the weight of the contextual link.
Details
string
getTitle()
Returns the localized title to be shown for this contextual link.
Subclasses may add optional arguments like NodeInterface $node = NULL that will be supplied by the ControllerResolver.
string
getRouteName()
Returns the route name of the contextual link.
string
getGroup()
Returns the group this contextual link should be rendered in.
A contextual link group is a set of contextual links that are displayed together on a certain page. For example, the 'block' group displays all links related to the block, such as the block instance edit link as well as the views edit link, if it is a view block.
array
getOptions()
Returns the link options passed to the link generator.
int
getWeight()
Returns the weight of the contextual link.
The contextual links in one group are sorted by weight for display.