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.236

Latest news

  • ProcessWire Weekly #555
    In the 555th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module that adds the ability to automatically convert email messages to pages, and more. Read on!
    Weekly.pw / 28 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer