public function BackgroundImageManagerInterface::getEntityBackgroundImage in Background Image 2.0.x

Same name and namespace in other branches

1. 8 src/BackgroundImageManagerInterface.php \Drupal\background_image\BackgroundImageManagerInterface::getEntityBackgroundImage()
2. 2.x src/BackgroundImageManagerInterface.php \Drupal\background_image\BackgroundImageManagerInterface::getEntityBackgroundImage()

Retrieves a background image that matches a specific entity.

Parameters

\Drupal\Core\Entity\EntityInterface $entity: The entity to use as the target.

string $langcode: (optional) The language of the current context. Defaults to the current content language.

array $context: (optional) An associative array of arbitrary data that can be useful to determine the proper fallback sequence.

Return value

\Drupal\background_image\BackgroundImageInterface|null A background image entity, if one exists.

1 method overrides BackgroundImageManagerInterface::getEntityBackgroundImage()

BackgroundImageManager::getEntityBackgroundImage in src/BackgroundImageManager.php

Retrieves a background image that matches a specific entity.

File

src/BackgroundImageManagerInterface.php, line 146

Class

BackgroundImageManagerInterface

Namespace

Drupal\background_image

Code

public function getEntityBackgroundImage(EntityInterface $entity, $langcode = NULL, array $context = []);