Load and render responsive image from field in Drupal 8

d8-responsive-image-programmatically.php

<?php

function _load_header_image($variables) {
  if ($node = $variables['node']) {
    // Load main_image
    $file = $node->field_main_image->entity;
    if ($file) {
      $variables = array(
        'responsive_image_style_id' => 'header_image',
        'uri' => $file->getFileUri(),
      );
      // The image.factory service will check if our image is valid.
      $image = \Drupal::service('image.factory')->get($file->getFileUri());
      if ($image->isValid()) {
        $variables['width'] = $image->getWidth();
        $variables['height'] = $image->getHeight();
      }
      else {
        $variables['width'] = $variables['height'] = NULL;
      }
      $logo_build = [
        '#theme' => 'responsive_image',
        '#width' => $variables['width'],
        '#height' => $variables['height'],
        '#responsive_image_style_id' => $variables['responsive_image_style_id'],
        '#uri' => $variables['uri'],
      ];
      // Add the file entity to the cache dependencies.
      // This will clear our cache when this entity updates.
      $renderer = \Drupal::service('renderer');
      $renderer->addCacheableDependency($logo_build, $file);

      // Return the render array as block content.
      return $logo_build;
    }
  }
  return NULL;
}

Thanks 👍

Perfect example, exactly what i was looking for, thank you!

Is it possible to pass an 'alt' attribute in this scenario? Adding a string '#alt' to $logo_build does not seem to have the expected effect.

You can have responsive images much easier. It will have alt and title, too.

// Set display options.
$display_options = [
  'label' => 'hidden',
  'type' => 'responsive_image',
  'settings' => [
    'responsive_image_style' => 'MYSTYLE',
  ],
];

// Get image, apply display options.
$image = $node->get('field_MYIMAGE')->view($display_options);

// Render.
$form['accordion']['items'][$key]['image'] = render($image);

---

When you need to get it from a media field it's almost the same, you just need to go one level deeper.

// Get media, get image, apply display options.
$image = $node->get('field_MYMEDIA')->entity->field_media_image->view($display_options);

@leymannx what if your image is not an image field but a reference field for a media entity?

Thanks so much -- this code saved my butt today! I couldn't figure out how to get the width and height of a media library entity, but I had gotten the URL. Your code took me that final step to the finish line 😀

@adamdelaney, I know your question is from a million years ago, but I'll go ahead and share what I did in case anybody else stumbles across this via google. Hopefully you can adapt my specific example more broadly to your specific use cases 😀

In a custom block I've got an entity reference field set up that uses the media library to select an image. In my .theme file, I'm using hook_preprocess_block to make the image file's info available in $variables so I can use it in my twig templates:

/**
 * Implements hook_preprocess_HOOK() for Block document templates.
 */
function insert_theme_name_preprocess_block(&$variables) {
  if (!empty($variables["elements"]["#id"]) && $variables["elements"]["#id"] == 'block_machine_name') {
    if (!empty($variables['elements']['content']['insert_image_field_name'])) {

      // get the image uri from the entity reference
      $uri = $variables['content']['#block_content']->get('insert_image_field_name')->entity->get('field_media_image')->entity->uri->value;

      // get the image attached to that uri
      $image = \Drupal::service('image.factory')->get($uri);

      // verify that it's really an image, and if so store the needed info as an object in $variables
      if ($image->isValid()) {
        $variables['insert_something_descriptive_here'] = [
          'url' => file_create_url($uri),
          'width' => $image->getWidth(),
          'height' => $image->getHeight(),
        ];
      }
    }
  }
}

@leymannx that saved my day!

I have a view returning an image with a responsive image style of type "Gallery thumbnail" and needed to have the same images in my view template but with a different responsive image style (that is "slider" to show them in a slider) and your code worked like a charm.

    // Preprocess slider images
    foreach ($view->result as $reference) {

      // Define responsive image display options
      $display_options = [
        'label'    => 'hidden',
        'type'     => 'responsive_image',
        'settings' => [
          'responsive_image_style' => 'slider',
        ],
      ];

      // Get image, apply display options
      $image = $reference->_entity->get('field_media_image')->view($display_options);

      // Render
      $responsive_image = render($image);

      // Set slider_images variable for template
      $variables['slider_images'][] = [
        'responsive_image' => $responsive_image
      ];
    }

//reference field for a media entity, with multiple values.

function MYTHEME_preprocess_node__CONTENT_TYPE(&$variables) {
  $display_options = [
    'label'    => 'hidden',
    'type'     => 'responsive_image',
    'settings' => [
      'responsive_image_style' => 'property_hero',
    ],
  ];
  foreach ($variables['node']->get('field_hero_images')->getValue() as $key => $value) {
    $media = Media::load($value['target_id']);
    $responsive_image = $media->field_media_image->view($display_options);
    $variables['hero_images'][] = [
      'hero_image' => $responsive_image
    ];
  }
}

Hi, I like the approach from @leymannx
Any chance to add a class to the responsive image?
In twig you can add a class to responsive image style using:
{% set responsiveImage = {
'#theme': 'responsive_image',
'#responsive_image_style_id': 'display_image_gallery',
'#uri': imagePath,
'#alt': altText,
'#attributes': { class: 'img-responsive' },
} %}