function MediaEmbed::getMediaImageSourceField

Same name and namespace in other branches
  1. 8.9.x core/modules/media/src/Plugin/Filter/MediaEmbed.php \Drupal\media\Plugin\Filter\MediaEmbed::getMediaImageSourceField()
  2. 10 core/modules/media/src/Plugin/Filter/MediaEmbed.php \Drupal\media\Plugin\Filter\MediaEmbed::getMediaImageSourceField()
  3. 11.x core/modules/media/src/Plugin/Filter/MediaEmbed.php \Drupal\media\Plugin\Filter\MediaEmbed::getMediaImageSourceField()

Get image field from source config.

Parameters

\Drupal\media\MediaInterface $media: A media entity.

Return value

string|null String of image field name.

1 call to MediaEmbed::getMediaImageSourceField()
MediaEmbed::applyPerEmbedMediaOverrides in core/modules/media/src/Plugin/Filter/MediaEmbed.php
Applies attribute-based per-media embed overrides of media information.

File

core/modules/media/src/Plugin/Filter/MediaEmbed.php, line 500

Class

MediaEmbed
Provides a filter to embed media items using a custom tag.

Namespace

Drupal\media\Plugin\Filter

Code

protected function getMediaImageSourceField(MediaInterface $media) {
    $field_definition = $media->getSource()
        ->getSourceFieldDefinition($media->bundle->entity);
    $item_class = $field_definition->getItemDefinition()
        ->getClass();
    if ($item_class == ImageItem::class || is_subclass_of($item_class, ImageItem::class)) {
        return $field_definition->getName();
    }
    return NULL;
}

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