The MediaImageDecorator adds image-specific functionality to Entity Embed when the current media entity is image-sourced. This functionality includes accepting alt text and title inputs. To determine whether a media entity should be treated as image-esque media, getMediaImageSourceField gets the media's source field and checks to see if it is an image field. This is perfectly reasonable.
However, I have a scenario where this logic excludes entities that can support (and need) image-specific treatment. I maintain the
Brandfolder →
module and we're about to offer Entity Browser and Entity Embed support there. That module provides a media source plugin for images stored in Brandfolder, which is an external DAM. Entities using that source have a "source field" that is not an image field (it's a text field containing a unique ID mapping to the external system), but they do have a fully functional Drupal image field that is derived from that source and is kept in sync with it.
Allow modules to alter the field name returned by MediaImageDecorator::getMediaImageSourceField().
Review.
Image-related fields would appear to end users if they are using a module that takes advantage of this new customizability.
New hook_entity_embed_media_image_source_field_alter hook. There should be no BC issues.
New ModuleHandlerInterface argument in MediaImageDecorator constructor, to enable its method to invoke that hook. If this class is only used internally, there should be no BC issues.
None.
Needs review
1.0
Code
Here is a patch that introduces the proposed changes and also updates the API file accordingly.
The second patch should apply against the latest non-dev Entity Embed release (8.x-1.3).