function Image::crop
Same name and namespace in other branches
- 9 core/lib/Drupal/Core/Image/Image.php \Drupal\Core\Image\Image::crop()
- 8.9.x core/lib/Drupal/Core/Image/Image.php \Drupal\Core\Image\Image::crop()
- 11.x core/lib/Drupal/Core/Image/Image.php \Drupal\Core\Image\Image::crop()
Crops an image to a rectangle specified by the given dimensions.
Parameters
int $x: The top left coordinate, in pixels, of the crop area (x axis value).
int $y: The top left coordinate, in pixels, of the crop area (y axis value).
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::crop
File
-
core/
lib/ Drupal/ Core/ Image/ Image.php, line 162
Class
- Image
- Defines an image object to represent an image file.
Namespace
Drupal\Core\ImageCode
public function crop($x, $y, $width, $height = NULL) {
return $this->apply('crop', [
'x' => $x,
'y' => $y,
'width' => $width,
'height' => $height,
]);
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.