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

Twitter updates

  • Happy New Year! Today I’ve bumped the version on the dev branch to 3.0.170, and it’s quite a lot of updates. This post covers most of them. In this post, there’s also a question for you: what would you like to see in ProcessWire in 2021? More
    1 January 2021
  • In this week’s blog post we’ll take a brief look at a powerful new ProFields module for ProcessWire that’s just around the corner—the Combo field: More
    4 December 2020
  • There’s a new modules directory on the ProcessWire site now up and running. In this post we’ll cover a few details about what’s changed and what’s new—More
    20 November 2020

Latest news

  • ProcessWire Weekly #347
    In the 347th issue of ProcessWire Weekly we'll check out ProcessWire 3.0.170, introduce the PDF Fieldtype/Inputfield module, and more. Read on!
    Weekly.pw / 2 January 2021
  • ProcessWire 3.0.170 core updates
    Happy New Year! Today I’ve bumped the version on the dev branch to 3.0.170, and it’s quite a lot of updates. This post covers most of them. In this post, there’s also a question for you: what would you like to see in ProcessWire in 2021?
    Blog / 1 January 2021
  • 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