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

Latest news

  • ProcessWire Weekly #565
    The 565th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 8 March 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer