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

Twitter updates

  • New TinyMCE 6.2.0 Inputfield released for ProcessWire— More
    28 October 2022
  • This week we take a look at a new rich text editor for ProcessWire, why we chose it, some highlights, screenshots, and why we think you’ll like it— More
    21 October 2022
  • This week we have ProcessWire 3.0.206 on the dev branch and a new version of the ProDevTools UserActivity module, which we'll take a closer look at in this post— More
    7 October 2022

Latest news

  • ProcessWire Weekly #447
    In the 447th issue of ProcessWire Weekly we'll share the latest core updates, introduce a new third party module called RockVideoThumbnailGrabber, and more. Read on!
    Weekly.pw / 3 December 2022
  • New rich text editor for ProcessWire
    This week we take a look at a new rich text editor for ProcessWire, why we chose it, some highlights, screenshots, and why we think you’ll like it.
    Blog / 21 October 2022
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer