function ImageEffectInterface::transformDimensions
Same name in other branches
- 9 core/modules/image/src/ImageEffectInterface.php \Drupal\image\ImageEffectInterface::transformDimensions()
- 8.9.x core/modules/image/src/ImageEffectInterface.php \Drupal\image\ImageEffectInterface::transformDimensions()
- 11.x core/modules/image/src/ImageEffectInterface.php \Drupal\image\ImageEffectInterface::transformDimensions()
Determines the dimensions of the styled image.
Parameters
array &$dimensions: Dimensions to be modified - an array with the following keys:
- width: the width in pixels, or NULL if unknown
- height: the height in pixels, or NULL if unknown
When either of the dimensions are NULL, the corresponding HTML attribute will be omitted when an image style using this image effect is used.
string $uri: Original image file URI. It is passed in to allow an effect to optionally use this information to retrieve additional image metadata to determine dimensions of the styled image. ImageEffectInterface::transformDimensions key objective is to calculate styled image dimensions without performing actual image operations, so be aware that performing IO on the URI may lead to decrease in performance.
1 method overrides ImageEffectInterface::transformDimensions()
- ImageEffectBase::transformDimensions in core/
modules/ image/ src/ ImageEffectBase.php - Determines the dimensions of the styled image.
File
-
core/
modules/ image/ src/ ImageEffectInterface.php, line 51
Class
- ImageEffectInterface
- Defines the interface for image effects.
Namespace
Drupal\imageCode
public function transformDimensions(array &$dimensions, $uri);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.