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.148

Twitter updates

  • Weekly update for Jan 10, 2020—front-end file uploads in LoginRegisterPro with InputfieldFrontendFile module: More
    10 January 2020
  • If you haven't seen it yet, be sure to check out this great infographic by @teppokoivula in ProcessWire Weekly #294— How ProcessWire professionals work—the results of our recent weekly polls summarised: weekly.pw/issue/294/#how…
    3 January 2020
  • Today we have a new master version released, 3.0.148! There are 25 new versions worth of upgrades, fixes and optimizations in this new master version, relative to the previous. In this post we take a closer look at what’s new, how to upgrade, & more— More
    3 January 2020

Latest news

  • ProcessWire Weekly #298
    In the 298th issue of ProcessWire Weekly we're going to take a quick look at the latest core updates, introduce the PWGeeks project, and highlight some recently released ProcessWire content. Read on!
    Weekly.pw / 25 January 2020
  • ProcessWire 3.0.148 new master
    Today we have a new master version released, version 3.0.148! The last master version was 3.0.123, so there are 25 new versions worth of upgrades, fixes and optimizations in this new master version, relative to the previous. In this post we’ll take a closer look at what’s new, how to upgrade, and more.
    Blog / 3 January 2020
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull