1 contextual.api.php hook_contextual_links_view_alter(&$element, $items)

Alter a contextual links element before it is rendered.

This hook is invoked by contextual_pre_render_links(). The renderable array of #type 'contextual_links', containing the entire contextual links data that is passed in by reference. Further links may be added or existing links can be altered.

Parameters

$element: A renderable array representing the contextual links.

$items: An associative array containing the original contextual link items, as generated by menu_contextual_links(), which were used to build $element['#links'].

See also

hook_menu_contextual_links_alter()

contextual_pre_render_links()

contextual_element_info()

Related topics

Hooks Allow modules to interact with the Backdrop core.

File

core/modules/contextual/contextual.api.php, line 31
Hooks provided by Contextual module.

Code

function hook_contextual_links_view_alter(&$element, $items) {
  // Add another class to all contextual link lists to facilitate custom
  // styling.
  $element['#attributes']['class'][] = 'custom-class';
}