Function __global->handle_images_cleanup_pipeline
Definitions
sources/images_cleanup_pipeline.php
- Cleanup an image to make it web-appropriate.This code is intentionally cowardly - it will just silently return if there are errors.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: N/A
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $path | PATH | required parameter | N/A | N/A | The image path |
| $filename | ?ID_TEXT | Null | N/A | N/A | The image filename (null: get from path) |
| $recompress_mode | integer | 1 | N/A | N/A | How to recompress, an IMG_RECOMPRESS_* constant |
| $maximum_dimension | ?integer | Null | N/A | N/A | The size of the bounding box (null: none) |
| $watermarks | ?array | Null | N/A | N/A | Watermark corners (top-left, top-right, bottom-left, bottom-right) (null: none) |
| $strip_gps | boolean | True | N/A | N/A | Whether to strip GPS metadata |