ProcessPageEditImageSelect class

Provides the image selecting and editing capability for rich text editors (TinyMCE/CKEditor)

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the ProcessPageEditImageSelect class also inherits all the methods and properties of: Process, WireData and Wire.

Common
Properties

Common

Name	Return	Summary
ProcessPageEditImageSelect::checkImageEditPermission() ProcessPageEditImageSelect::checkImageEditPermission() ProcessPageEditImageSelect::checkImageEditPermission(bool $throw = true)	`bool`	Check if user has image edit permission and throw exception if they don't
ProcessPageEditImageSelect::execute() ProcessPageEditImageSelect::execute() ProcessPageEditImageSelect::execute()	`string`	Default execute: display list of images on page for selection
ProcessPageEditImageSelect::executeEdit() ProcessPageEditImageSelect::executeEdit() ProcessPageEditImageSelect::executeEdit()	`string`	Edit a selected image
ProcessPageEditImageSelect::executeResize() ProcessPageEditImageSelect::executeResize() ProcessPageEditImageSelect::executeResize()	`string`	Resize image and output basic markup with information about the resize
ProcessPageEditImageSelect::executeVariations() ProcessPageEditImageSelect::executeVariations() ProcessPageEditImageSelect::executeVariations()	`string`	Show all variations for the image provided in GET var 'file'
ProcessPageEditImageSelect::getImageFields() ProcessPageEditImageSelect::getImageFields(Page $page) ProcessPageEditImageSelect::getImageFields(Page $page, bool $excludeFullFields = true)	`array`	Get all editable image fields on the page
ProcessPageEditImageSelect::getImages() ProcessPageEditImageSelect::getImages(Page $page) ProcessPageEditImageSelect::getImages(Page $page, $fields = [], int $level = 0)	`array`	Get all Pageimage objects on page
ProcessPageEditImageSelect::getPageimage() ProcessPageEditImageSelect::getPageimage() ProcessPageEditImageSelect::getPageimage(bool $getVariation = false)	`Pageimage`	Return the Pageimage object being edited

Properties

Name	Return	Summary
ProcessPageEditImageSelect::alignCenterClass	`string`	Align center class (align_center recommended)
ProcessPageEditImageSelect::alignLeftClass	`string`	Align left class (align_left recommended)
ProcessPageEditImageSelect::alignRightClass	`string`	Align right class (align_right recommended)
ProcessPageEditImageSelect::hidpiDefault	`int`	HiDPI/Retina checkbox default checked?
ProcessPageEditImageSelect::noSizeAttrs	`int`	Skip width attributes on image tags? (not recommended if you want HiDPI support)
ProcessPageEditImageSelect::noThumbs	`int`	Do not generate thumbnail images (make image selection will use full-size images).

Additional methods and properties

In addition to the methods and properties above, ProcessPageEditImageSelect also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.251