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

Latest news

  • ProcessWire Weekly #550
    In the 550th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module called PagefileMetadata, and more. Read on!
    Weekly.pw / 23 November 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

“…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