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
| Name | Type(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 returnedheight (int): only variations with given height will be returnedwidth>= (int): only variations with width greater than or equal to given will be returnedheight>= (int): only variations with height greater than or equal to given will be returnedwidth<= (int): only variations with width less than or equal to given will be returnedheight<= (int): only variations with height less than or equal to given will be returnedsuffix (string): only variations having the given suffix will be returnedsuffixes (array): only variations having one of the given suffixes will be returnednoSuffix (string): exclude variations having this suffixnoSuffixes (array): exclude variations having any of these suffixesname (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 arrayReturns 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.236