Allow image effects to change the MIME type + extension, add a "convert" image effect

Open on Drupal.org →

Created on 1 September 2014, almost 10 years ago

Updated 3 January 2024, 6 months ago

Follow-up to #2262863: Add srcset to template_preprocess_image →

Problem/Motivation

The new picture html tag allows to define alternatives based on mime type (image format) using the type attribute. To render this attribute, we need to be able to determine the mime type of a derivative without generating it.
To be able to generate derivatives in multiple output formats, we need an image effect that can change the format an image is saved in.

Proposed resolution

Add ImageEffectInterface::getDerivativeMimeType(&$mime_type)
Add ImageEffectInterface::getDerivativeExtension(&$extension)
Now that ImageStyle supports changing the MIME type & extension, add a "convert" ImageEffect

User interface changes

None

API changes

Adds ImageEffectInterface::getDerivativeMimeType(&$mime_type)
Adds ImageStyleInterface::getDerivativeMimeType(&$mime_type)
Adds ImageEffectInterface::getDerivativeExtension(&$extension)
Adds ImageStyleInterface::getDerivativeExtension(&$extension)
Adds ImageInterface::convert($format)
(Adds \Drupal\image\Plugin\ImageEffect\ConvertImageEffect)
(Adds \Drupal\system\Plugin\ImageToolkit\Operation\gd\Convert)

📌 Task

Status

Fixed

Version

8.0 ⚰️

Component

Image system →

Last updated about 4 hours ago

Maintained by
🇷🇴Romania @claudiu.cristea

Created by

🇧🇪Belgium attiks

Live updates comments and jobs are added and updated live.

API addition
Enhances an existing API or introduces a new subsystem. Depending on the size and impact, possibly backportable to earlier major versions.

D8Media

Incomplete comments

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment about 1 year ago →
🇮🇳India bendale
Hey everyone, I'm curious to know if there's a particular reason for keeping both the old extension and the new one when using the convert effect.
Comment 6 months ago →
🇺🇸United States Chris Burge
@bendale - That's an excellent question. The source of the issue is potential namespace conflicts. Let's say you have image.jpg and image.png. If both are converted to webp, then you have an problem. I've dug into this very issue over the past week and should probably open a new issue against core. I don't have a solution, but I think it deserves its own issue for discussion.
Comment 6 months ago →
🇺🇸United States Chris Burge
On a related note, this issue introduced a bug, 🐛 ImageStyleDownloadController::deliver() infers source image when generating derivatives with image format conversion Active , which would need to be addressed if we wanted to solve for replacing an image file extension instead of appending it when converting.

contrib.social Blog FAQ Discussions

Production build 0.69.0 2024