ImageSizer::resize() method

Resize the image proportionally to the given width/height

Usage

// basic usage
$bool = $imageSizer->resize(int $targetWidth);

// usage with all arguments
$bool = $imageSizer->resize(int $targetWidth, int $targetHeight = 0);

Arguments

Name	Type(s)	Description
`targetWidth`	int	Target width in pixels, or 0 for proportional to height
`targetHeight` (optional)	int	Target height in pixels, or 0 for proportional to width. Optional-if not specified, 0 is assumed.

Return value

bool

True if the resize was successful, false if not

Exceptions

Method can throw exceptions on error:

WireException - when not enough memory to load image or missing required data

Hooking ImageSizer::resize(…)

You can add your own hook events that are executed either before or after the ImageSizer::resize(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each ImageSizer::resize(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('ImageSizer::resize', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $ImageSizer = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $targetWidth = $event->arguments(0);
  $targetHeight = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $targetWidth);
  $event->arguments(1, $targetHeight);
});

Hooking after

The 'after' hooks are called immediately after each ImageSizer::resize(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('ImageSizer::resize', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $ImageSizer = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $targetWidth = $event->arguments(0);
  $targetHeight = $event->arguments(1);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

ImageSizer methods and properties

API reference based on ProcessWire core version 3.0.244