template_preprocess_image_style

template_preprocess_image_style(&$variables)

Prepares variables for image style templates.

Default template: image-style.html.twig.

Parameters

array $variables: An associative array containing:

• width: The width of the image.
• height: The height of the image.
• style_name: The name of the image style to be applied.
• attributes: Additional attributes to apply to the image.
• uri: URI of the source image before styling.
• alt: The alternative text for text-based browsers. HTML 4 and XHTML 1.0 always require an alt attribute. The HTML 5 draft allows the alt attribute to be omitted in some cases. Therefore, this variable defaults to an empty string, but can be set to NULL for the attribute to be omitted. Usually, neither omission nor an empty string satisfies accessibility requirements, so it is strongly encouraged for code using '#theme' => 'image_style' to pass a meaningful value for this variable.
  • http://www.w3.org/TR/REC-html40/struct/objects.html#h-13.8
  • http://www.w3.org/TR/xhtml1/dtds.html
  • http://dev.w3.org/html5/spec/Overview.html#alt
• title: The title text is displayed when the image is hovered in some popular browsers.
• attributes: Associative array of attributes to be placed in the img tag.

File

core/modules/image/image.module, line 282

Exposes global functionality for creating image styles.

Code

function template_preprocess_image_style(&$variables) {
  $style = ImageStyle::load($variables['style_name']);

  // Determine the dimensions of the styled image.
  $dimensions = array(
    'width' => $variables['width'],
    'height' => $variables['height'],
  );

  $style->transformDimensions($dimensions, $variables['uri']);

  $variables['image'] = array(
    '#theme' => 'image',
    '#width' => $dimensions['width'],
    '#height' => $dimensions['height'],
    '#attributes' => $variables['attributes'],
    '#uri' => $style->buildUrl($variables['uri']),
    '#style_name' => $variables['style_name'],
  );

  if (isset($variables['alt']) || array_key_exists('alt', $variables)) {
    $variables['image']['#alt'] = $variables['alt'];
  }
  if (isset($variables['title']) || array_key_exists('title', $variables)) {
    $variables['image']['#title'] = $variables['title'];
  }

}