function ImageInterface::scaleAndCrop

Same name in other branches
  1. 9 core/lib/Drupal/Core/Image/ImageInterface.php \Drupal\Core\Image\ImageInterface::scaleAndCrop()
  2. 10 core/lib/Drupal/Core/Image/ImageInterface.php \Drupal\Core\Image\ImageInterface::scaleAndCrop()
  3. 11.x core/lib/Drupal/Core/Image/ImageInterface.php \Drupal\Core\Image\ImageInterface::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.

1 method overrides ImageInterface::scaleAndCrop()
Image::scaleAndCrop in core/lib/Drupal/Core/Image/Image.php
Scales an image to the exact width and height given.

File

core/lib/Drupal/Core/Image/ImageInterface.php, line 170

Class

ImageInterface
Provides an interface for image objects.

Namespace

Drupal\Core\Image

Code

public function scaleAndCrop($width, $height);

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