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): 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).
  • 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.125

Twitter updates

  • New post: This week we take a look at what’s in ProcessWire 3.0.126 which focuses largely on resolving issue reports, but also includes a handy new Page if() method— More
    15 February 2019
  • New post: ProcessWire 3.0.125 has several useful new Sanitizer methods & options, plus new ways to access them directly from the Input API variable. This makes handling user input even easier than before. Plus updates to our i18n functions & API docs— More
    25 January 2019
  • New post: In this week’s post, we’ll take a look a look at the new website and focus on some parts of it and how they were built. Then we’ll dive into the latest version of ProcessWire on the dev branch, version 3.0.124— More
    11 January 2019

Latest news

  • ProcessWire Weekly #249
    In the 249th issue of ProcessWire Weekly we're going to walk you through the latest core updates (ProcessWire 3.0.126), introduce a new third party module called Page Access Releasetime, and pick a new site of the week. Read on!
    Weekly.pw / 16 February 2019
  • ProcessWire 3.0.126 core updates
    This week we take a look at what’s in ProcessWire 3.0.126 which focuses largely on resolving issue reports, but also includes a handy new $page->if() method. 
    Blog / 15 February 2019
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer