Pageimage::crop() method

Create a crop and return it as a new Pageimage.

Example

// Create a crop starting 100 pixels from left, 200 pixels from top
// at 150 pixels wide and 100 pixels tall
$image = $page->images->first();
$crop = $image->crop(100, 200, 150, 100);

// Output the crop
echo "<img src='$crop->url' />";

Usage

// basic usage
$pageimage = $pageimage->crop(int $x, int $y, int $width, int $height);

// usage with all arguments
$pageimage = $pageimage->crop(int $x, int $y, int $width, int $height, array $options = []);

Arguments

NameType(s)Description
xint

Starting X position (left) in pixels

yint

Starting Y position (top) in pixels

widthint

Width of crop in pixels

heightint

Height of crop in pixels

options (optional)array

See options array for Pageimage::size() method. Avoid setting crop properties in $options since we are overriding them.

Return value


Hooking Pageimage::crop(…)

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

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

  // Get values of arguments sent to hook (and optionally modify them)
  $x = $event->arguments(0);
  $y = $event->arguments(1);
  $width = $event->arguments(2);
  $height = $event->arguments(3);
  $options = $event->arguments(4);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $x);
  $event->arguments(1, $y);
  $event->arguments(2, $width);
  $event->arguments(3, $height);
  $event->arguments(4, $options);
});

Hooking after

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

$this->addHookAfter('Pageimage::crop', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $Pageimage = $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)
  $x = $event->arguments(0);
  $y = $event->arguments(1);
  $width = $event->arguments(2);
  $height = $event->arguments(3);
  $options = $event->arguments(4);

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

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

Pageimage methods and properties

API reference based on ProcessWire core version 3.0.137

Twitter updates

  • ProcessWire 3.0.146 on the dev branch contains about 22 commits with a combination of useful upgrades and issue report resolutions, more details in this forum post: More
    22 November 2019
  • ProcessWire 3.0.144 and 3.0.145 add improved field template context override settings and include a new Inputfields API, along with numerous other issue fixes, optimizations and improvements to the core. More
    8 November 2019
  • ProcessWire 3.0.144 core updates: Upgraded overrides section in the field editor, a new Inputfields JS API, and more— More
    1 November 2019

Latest news

  • ProcessWire Weekly #291
    In the 291st issue of ProcessWire Weekly we're going to take a closer look at the latest core updates, check out a brand new third party module called ProcessHelpVideos, and introduce a new site of the week. Read on!
    Weekly.pw / 8 December 2019
  • New User Activity module
    Blog / 29 November 2019
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer