Pageimage::removeVariations() method

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

Name Type(s) Description

Name	Type(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).

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

Pageimage::removeVariations() method

Delete all the alternate sizes associated with this Pageimage

Usage

Arguments

Return value

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news