function ContextualLinksPlaceholder::preRenderPlaceholder

Same name in other branches
  1. 8.9.x core/modules/contextual/src/Element/ContextualLinksPlaceholder.php \Drupal\contextual\Element\ContextualLinksPlaceholder::preRenderPlaceholder()
  2. 10 core/modules/contextual/src/Element/ContextualLinksPlaceholder.php \Drupal\contextual\Element\ContextualLinksPlaceholder::preRenderPlaceholder()
  3. 11.x core/modules/contextual/src/Element/ContextualLinksPlaceholder.php \Drupal\contextual\Element\ContextualLinksPlaceholder::preRenderPlaceholder()

Pre-render callback: Renders a contextual links placeholder into #markup.

Renders an empty (hence invisible) placeholder div with a data-attribute that contains an identifier ("contextual id"), which allows the JavaScript of the drupal.contextual-links library to dynamically render contextual links.

Parameters

array $element: A structured array with #id containing a "contextual id".

Return value

array The passed-in element with a contextual link placeholder in '#markup'.

See also

_contextual_links_to_id()

File

core/modules/contextual/src/Element/ContextualLinksPlaceholder.php, line 47

Class

ContextualLinksPlaceholder
Provides a contextual_links_placeholder element.

Namespace

Drupal\contextual\Element

Code

public static function preRenderPlaceholder(array $element) {
    $token = Crypt::hmacBase64($element['#id'], Settings::getHashSalt() . \Drupal::service('private_key')->get());
    $attribute = new Attribute([
        'data-contextual-id' => $element['#id'],
        'data-contextual-token' => $token,
    ]);
    $element['#markup'] = new FormattableMarkup('<div@attributes></div>', [
        '@attributes' => $attribute,
    ]);
    return $element;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.