Pageimage::sizeName() method

Return image of size indicated by predefined setting

Settings for predefined sizes can be specified in $config->imageSizes array. Each named item in this array must contain at least 'width' and 'height, but can also contain any other option from the Pageimage::size() argument $options.

Available since version 3.0.151.

Usage

// basic usage
$pageimage = $pageimage->sizeName(string $name);

// usage with all arguments
$pageimage = $pageimage->sizeName(string $name, array $options = []);

Arguments

NameType(s)Description
namestring

Image size name

options (optional)array

Optionally add or override options defined for size.

Return value

Exceptions

Method can throw exceptions on error:

  • WireException - If given a $name that is not present in $config->imageSizes


Pageimage methods and properties

API reference based on ProcessWire core version 3.0.248

Latest news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits