Pageimage::getVariations() method

Get all size variations of this image

This is useful after a delete of an image (for example). This method can be used to track down all the child files that also need to be deleted.

Usage

// basic usage
$pageimages = $pageimage->getVariations();

// usage with all arguments
$pageimages = $pageimage->getVariations(array $options = []);

Arguments

NameType(s)Description
options (optional)array

Optional, one or more options in an associative array of the following:

  • info (bool): when true, method returns variation info arrays rather than Pageimage objects (default=false).
  • verbose (bool|int): Return verbose array of info. If false, returns only filenames (default=true). This option does nothing unless the info option is true. Also note that if verbose is false, then all options following this one no longer apply (since it is no longer returning width/height info). When integer 1, returned info array also includes Pageimage variation options in 'pageimage' index of returned arrays (since 3.0.137).
  • width (int): only variations with given width will be returned
  • height (int): only variations with given height will be returned
  • width>= (int): only variations with width greater than or equal to given will be returned
  • height>= (int): only variations with height greater than or equal to given will be returned
  • width<= (int): only variations with width less than or equal to given will be returned
  • height<= (int): only variations with height less than or equal to given will be returned
  • suffix (string): only variations having the given suffix will be returned
  • suffixes (array): only variations having one of the given suffixes will be returned
  • noSuffix (string): exclude variations having this suffix
  • noSuffixes (array): exclude variations having any of these suffixes
  • name (string): only variations containing this text in filename will be returned (case insensitive)
  • noName (string): only variations NOT containing this text in filename will be returned (case insensitive)
  • regexName (string): only variations that match this PCRE regex will be returned

Return value

Pageimages array

Returns Pageimages array of Pageimage instances. Only returns regular array if provided $options['info'] is true.


Pageimage methods and properties

API reference based on ProcessWire core version 3.0.184

Twitter updates

  • ProcessWire 3.0.185 (dev) core updates, plus new Session Allow module— More
    17 September 2021
  • Three new ProcessWire Textformatter modules: Find/Replace, Markdown in Markup, and Emoji— More
    3 September 2021
  • This week we have a new master version released after a year in the making. With nearly 40 pull requests, hundreds of new additions and more than 100 issue reports resolved, this new version has a ton of great new stuff— More
    27 August 2021

Latest news

  • ProcessWire Weekly #384
    In the 384th issue of ProcessWire Weekly we'll cover the latest core updates, introduce a new module called Session Allow, and highlight a new site of the week. Read on!
    Weekly.pw / 18 September 2021
  • ProcessWire 3.0.184 new master/main version
    This week we have a new master/main version released after a full year in the making. As you might imagine, this new version has a ton of great new stuff and we’ll try to cover much of it here.
    Blog / 27 August 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