Pageimage::maxHeight() method

Return an image no larger than the given height.

If source image is equal to or smaller than the requested dimension, then it will remain that way and the source image is returned (not a copy).

If the source image is larger than the requested dimension, then a new copy will be returned at the requested dimension.

Usage

// basic usage
$pageimage = $pageimage->maxHeight(int $n);

// usage with all arguments
$pageimage = $pageimage->maxHeight(int $n, array $options = []);

Arguments

NameType(s)Description
nint

Maximum height

options (optional)array

See Pageimage::size() method for options

Return value


Pageimage methods and properties

API reference based on ProcessWire core version 3.0.244

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull