public function Image::scaleAndCrop in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Image/Image.php \Drupal\Core\Image\Image::scaleAndCrop()

Scales an image to the exact width and height given.

This function achieves the target aspect ratio by cropping the original image equally on both sides, or equally on the top and bottom. This function is useful to create uniform sized avatars from larger images.

The resulting image always has the exact target dimensions.

Parameters

int $width: The target width, in pixels.

int $height: The target height, in pixels.

Return value

bool TRUE on success, FALSE on failure.

Overrides ImageInterface::scaleAndCrop

File

core/lib/Drupal/Core/Image/Image.php, line 190

Class

Image

Defines an image object to represent an image file.

Namespace

Drupal\Core\Image

Code

public function scaleAndCrop($width, $height) {
  return $this
    ->apply('scale_and_crop', [
    'width' => $width,
    'height' => $height,
  ]);
}