ProcessPageEditImageSelect::executeEdit()
Edit a selected image
Required GET variables:
- file (string): URL of image, or preferably "123,basename.jpg" where 123 is ID.
- id (int): ID of page images is from, optional if specified in 'file'.
Optional GET variables:
- edit_page_id (int): ID of the page being edited, where image will be placed.
- width (int): Current width of image in the editor
- height (int): Current height of image in the editor
- winwidth (int): Current width of client-side window in pixels
- 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)
- link: (string): URL that image is linking to in the editor.
- description: (string): Text for description "alt" tag.
- rte (int): Rich text editor mode (0=off, 1 or omit=on)
- field (string): Name of field (for non-rte mode)
Optional GET variables that must come together as a group. When present, the image editor will start in crop mode and show the original image with this portion selected for crop:
- crop_x (int): Predefined crop left position
- crop_y (int): Predefined crop top position
- crop_w (int): Predefined crop width
- crop_h (int): Predefined crop height
Usage
$string = $processPageEditImageSelect->executeEdit();
Return value
string
Exceptions
Method can throw exceptions on error:
\Exception
orWireException
Hooking ProcessPageEditImageSelect::executeEdit()
You can add your own hook events that are executed either before or after the Process
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 Process
method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('ProcessPageEditImageSelect::executeEdit', 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 Process
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::executeEdit', 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