Pageimage::removeVariations()

Delete all the alternate sizes associated with this Pageimage

Usage

// basic usage
$pageImageVariations = $pageimage->removeVariations();

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

Arguments

NameType(s)Description
$options (optional)array

See options for getVariations() method to limit what variations are removed, plus these:

  • dryRun (bool): Do not remove now and instead only return the filenames of variations that would be deleted Default:false
  • getFiles (bool): Return deleted filenames? Also assumed if the test option is used Default:false

Return value

PageImageVariations array

Returns $this by default, or array of deleted filenames if the getFiles option is specified

Pageimage methods and properties

API reference based on ProcessWire core version 3.0.252