Pagefiles class

Pagefiles is a type of WireArray that contains Pagefile objects. It also acts as the value for multi-file fields in ProcessWire.

The items in a Pagefiles array are Pagefile objects, indexed by file basename, i.e. myfile.pdf. Information on most traversal, filtering and manipulation methods can be found in the WireArray class that Pagefiles extends. In the examples below, $page->files is an instance of Pagefiles:

// Determining if any files are present
if($page->files->count()) {
  // There are files here
}

// Traversing and outputting links to all files
foreach($page->files as $name => $pagefile) {
  echo "<li><a href='$pagefile->url'>$name: $pagefile->description</a></li>";
}

// Adding new file(s)
$page->files->add('/path/to/file.pdf');
$page->files->add('http://domain.com/photo.png');
$page->save('files');

// Getting file by name
$pagefile = $page->files->getFile('file.pdf');
$pagefile = $page->files['file.pdf']; // alternate

// Getting first and last file
$pagefile = $page->files->first();
$pagefile = $page->files->last();

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

Show class?             Show args?        

Common

NameReturnSummary 
Pagefiles::clone(Pagefile $item)
Pagefile boolDuplicate the Pagefile and add to this Pagefiles instance
Pagefiles::formatted()
boolGet or set formatted state 
Pagefiles::getField()
Field nullGet the field these files are assigned to 
Pagefiles::getFile(string $name)
null PagefileGet the Pagefile having the given basename, or null if not found. 
Pagefiles::getPage()
PageGet the page these files are assigned to 
Pagefiles::path()
stringReturn the full disk path where files are stored
Can also be used as property: Pagefiles::path
 
Pagefiles::setField(Field $field)
(nothing)Set the field these files are assigned to 
Pagefiles::setPage(Page $page)
(nothing)Set the Page these files are assigned to 
Pagefiles::url()
stringReturns the web accessible index URL where files are stored
Can also be used as property: Pagefiles::url
 

Manipulation

NameReturnSummary 
Pagefiles::add($item)
$thisAdd a new Pagefile item or filename 
Pagefiles::delete($item)
$thisDelete a pagefile item
Pagefiles::deleteAll()
$thisDelete all files associated with this Pagefiles instance, leaving a blank Pagefiles instance. 
Pagefiles::rename(Pagefile $item, string $name)
PagefilesQueue a rename of a Pagefile 

Tags

NameReturnSummary 
Pagefiles::findTag($tag)
PagefilesReturn all Pagefile objects that have the given tag(s). 
Pagefiles::getTag(string $tag)
Pagefile nullReturn the first Pagefile that matches the given tag or NULL if no match 
Pagefiles::tags()
string array PagefilesGet list of tags for all files in this Pagefiles array, or return files matching given tag(s) 

Other

NameReturnSummary 
Pagefiles::field Field Returns the Field that contains this set of files, same as the getField() method.  
Pagefiles::page Page Returns the Page that contains this set of files, same as the getPage() method.  

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.137

Twitter updates

  • New post: This week we’ll take a look at a new version of FormBuilder that's on the way (with a screencast), as well as the latest version of the core: ProcessWire 3.0.140— More
    6 September 2019
  • We added WebP image support this year and many have been adopting it in existing projects. We look at a process used for migrating existing websites to WebP images— from preliminary considerations to implementation & testing, w/lots of tips & tricks too: More
    16 August 2019
  • Core version 3.0.137 on the dev branch adds the ability to hook multiple methods at once, in a single call. This post details how it works and provides a useful example of how you might put it to use in your development environment— More
    2 August 2019

Latest news

  • ProcessWire Weekly #279
    This week in the 279th issue of ProcessWire Weekly we're going to introduce some of the latest third party modules out there, and highlight a brand new site of the week. Read on!
    Weekly.pw / 14 September 2019
  • ProcessWire 3.0.140 and FormBuilder v40
    This week we’ll take a look at a new version of FormBuilder that's on the way (with a screencast), as well as the latest version of the core: ProcessWire 3.0.140.
    Blog / 6 September 2019
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer