function hook_contextual_links_view_alter in Drupal 7

Same name and namespace in other branches

1. 8 core/modules/contextual/contextual.api.php \hook_contextual_links_view_alter()
2. 9 core/modules/contextual/contextual.api.php \hook_contextual_links_view_alter()

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

1 invocation of hook_contextual_links_view_alter()

contextual_pre_render_links in modules/contextual/contextual.module

Build a renderable array for contextual links.

File

modules/contextual/contextual.api.php, line 32

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';
}