Function __global->adjust_pic_size

Definitions

sources/images_cleanup_pipeline.php

  • Adjust an image to a maximum bounding box size.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$image resource No No required parameter N/A N/A GD image resource
$maximum_dimension integer No No required parameter N/A N/A The size of the bounding box

Returns

  • A pair: Adjusted GD image resource, Whether a change was made
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Adjust an image to a maximum bounding box size.
 *
 * @param  resource $image GD image resource
 * @param  integer $maximum_dimension The size of the bounding box
 * @return array A pair: Adjusted GD image resource, Whether a change was made
 */
function adjust_pic_size($image, int $maximum_dimension) : array