drupal/core/modules/contextual/contextual.api.php

43 lines
1.2 KiB
PHP

<?php
/**
* @file
* Hooks provided by Contextual module.
*/
/**
* @addtogroup hooks
* @{
*/
/**
* Alter a contextual links element before it is rendered.
*
* This hook is invoked by
* \Drupal\contextual\Element\ContextualLinks::preRenderLinks(). 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.
*
* @param $element
* A renderable array representing the contextual links.
* @param $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 hook_contextual_links_alter()
* @see hook_contextual_links_plugins_alter()
* @see \Drupal\contextual\Element\ContextualLinks::preRenderLinks()
*/
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';
}
/**
* @} End of "addtogroup hooks".
*/