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::getFieldsPage()
PageGet mock/placeholder Page object used for Pagefile custom fields 
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.185

Twitter updates

  • ProcessWire 3.0.185 (dev) core updates, plus new Session Allow module— More
    17 September 2021
  • Three new ProcessWire Textformatter modules: Find/Replace, Markdown in Markup, and Emoji— More
    3 September 2021
  • This week we have a new master version released after a year in the making. With nearly 40 pull requests, hundreds of new additions and more than 100 issue reports resolved, this new version has a ton of great new stuff— More
    27 August 2021

Latest news

  • ProcessWire Weekly #388
    In the 388th issue of ProcessWire Weekly we'll check out the latest core update, introduce two new third party modules, and more. Read on!
    Weekly.pw / 16 October 2021
  • ProcessWire 3.0.184 new master/main version
    This week we have a new master/main version released after a full year in the making. As you might imagine, this new version has a ton of great new stuff and we’ll try to cover much of it here.
    Blog / 27 August 2021
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani