function hook_contextual_links_view_alter in Drupal 10
Same name and namespace in other branches
- 8 core/modules/contextual/contextual.api.php \hook_contextual_links_view_alter()
- 7 modules/contextual/contextual.api.php \hook_contextual_links_view_alter()
- 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 \Drupal\Core\Menu\ContextualLinkManagerInterface::getContextualLinksArrayByGroup(), which were used to build $element['#links'].
See also
hook_contextual_links_plugins_alter()
contextual_pre_render_links()
Related topics
4 functions implement hook_contextual_links_view_alter()
Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.
- contextual_contextual_links_view_alter in core/
modules/ contextual/ contextual.module - Implements hook_contextual_links_view_alter().
- contextual_test_contextual_links_view_alter in core/
modules/ contextual/ tests/ modules/ contextual_test/ contextual_test.module - Implements hook_contextual_links_view_alter().
- settings_tray_contextual_links_view_alter in core/
modules/ settings_tray/ settings_tray.module - Implements hook_contextual_links_view_alter().
- views_ui_contextual_links_view_alter in core/
modules/ views_ui/ views_ui.module - Implements hook_contextual_links_view_alter().
1 invocation of hook_contextual_links_view_alter()
- ContextualLinks::preRenderLinks in core/
modules/ contextual/ src/ Element/ ContextualLinks.php - Pre-render callback: Builds a renderable array for contextual links.
File
- core/
modules/ contextual/ contextual.api.php, line 33 - 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';
}