Pageimage::maxWidth() method

Return an image no larger than the given width.

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->maxWidth(int $n);

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

Arguments

NameType(s)Description
nint

Maximum width

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

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer