Pageimages are a type of WireArray containing Pageimage objects. They represent the value of multi-image field in ProcessWire.
Most of the methods you are likely to use are inherited from Pagefiles and WireArray so be sure to take a look at those as well. Pageimages is dedicated to containing Pageimage objects.
// Example of outputting a thumbnail gallery of Pageimage objects
foreach($page->images as $image) {
// $page->images is a Pageimages object
// $image and $thumb are both Pageimage objects
$thumb = $image->size(200, 200);
echo "<a href='$image->url'>";
echo "<img src='$thumb->url' alt='$image->description' />";
echo "</a>";
}Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Pageimages class also inherits all the methods and properties of: Pagefiles, WireArray and Wire.
Common
| Name | Return | Summary | |
|---|---|---|---|
Pageimages::add() Pageimages::add($item) Pageimages::add($item) | Pageimages Pagefiles | Add a new Pageimage item, or create one from given filename and add it. | |
Pageimages::getAllVariations() Pageimages::getAllVariations() Pageimages::getAllVariations() | array | Get an array of all image variations on this field indexed by original file name. | |
Pageimages::getFile() Pageimages::getFile(string $name) Pageimages::getFile(string $name) | null Pagefile Pageimage | Does this field have the given file name? If so, return it, if not return null. | |
Pageimages::render() Pageimages::render() Pageimages::render($markup = '', $options = []) | string | Render markup for all images here (optionally using a provided markup template string and/or image size options) |
Additional methods and properties
In addition to the methods and properties above, Pageimages also inherits the methods and properties of these classes:
API reference based on ProcessWire core version 3.0.236