Pageimages class

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.

Show class?             Show args?        

Common

NameReturnSummary 
Pageimages::add($item)
Pageimages PagefilesAdd a new Pageimage item, or create one from given filename and add it. 
Pageimages::getAllVariations()
arrayGet an array of all image variations on this field indexed by original file name. 
Pageimages::getFile(string $name)
null Pagefile PageimageDoes this field have the given file name? If so, return it, if not return null. 
Pageimages::render()
stringRender 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.185

Twitter updates

  • ProcessWire 3.0.192 (dev branch) contains 11 issue fixes and 5 pull requests, over 20 commits— More
    7 January 2022
  • ProcessWire 3.0.191 core updates: updates to the installer and the profile exporter module— More
    24 December 2021
  • This week ProcessWire went on a diet, trimming the core size from 15.5 MB down to 7.5 MB by moving optional site profiles into their own GitHub repos— More
    17 December 2021

Latest news

  • ProcessWire Weekly #402
    In the 402nd issue of ProcessWire Weekly we'll check out ProcessWire 3.0.193, highlight recent ProcessWire projects and resources, and more. Read on!
    Weekly.pw / 22 January 2022
  • ProcessWire 3.0.190 core updates
    ProcessWire 3.0.190 has 15 commits relative to 3.0.189 and contains a mixture of issue resolutions and feature additions. This post covers them all, in addition to updates for the PageAutosave and ProFields Table modules.
    Blog / 3 December 2021
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK