ProcessPageEditImageSelect::executeResize()

Resize image and output basic markup with information about the resize

The output is intended to be read by the rich text editor for insertion into the text.

Required GET variables:

file (string): URL of image
width (int): Target resize width
edit_page_id (int): ID of the page being edited, where image will be placed.

Optional GET variables:

id (int): ID of the page the image lives on (if omitted, we attempt to determine from 'file' path).
class (string): Class name to pass along to the editor (i.e. align_left, align_right, etc.)
hidpi (int): Whether hidpi mode is used or not (0=no, 1=yes)
json (int): Specify 1 to provide output in JSON (if not specified, output is a paragraph of markup)

Usage

$string = $processPageEditImageSelect->executeResize();

Return value

string

Exceptions

Method can throw exceptions on error:

WireException

Hooking ProcessPageEditImageSelect::executeResize()

You can add your own hook events that are executed either before or after the ProcessPageEditImageSelect::executeResize() 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 ProcessPageEditImageSelect::executeResize() method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

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

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
});

Hooking after

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

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

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

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

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

ProcessPageEditImageSelect methods and properties

API reference based on ProcessWire core version 3.0.252