Pagefile class

Represents a single file item attached to a page, typically via a File Fieldtype.

Pagefile objects are contained by a Pagefiles object.


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

Show class?             Show args?        

Common

NameReturnSummary 
Pagefile::__construct(Pagefiles $pagefiles, string $filename)
(nothing)Construct a new Pagefile 
Pagefile::basename()
stringReturns the basename of this Pagefile (name and extension, without disk path).
Can also be used as property: Pagefile::basename
 
Pagefile::description()
string arrayGet or set the file’s description (with multi-language support).
Can also be used as property: Pagefile::description
 
Pagefile::ext()
stringReturns the file’s extension - "pdf", "jpg", etc.
Can also be used as property: Pagefile::ext
 
Pagefile::filedata array 
Pagefile::filename()
stringReturns the full disk path name filename to the Pagefile.
Can also be used as property: Pagefile::filename
 
Pagefile::filesize()
intReturns the filesize in number of bytes.
Can also be used as property: Pagefile::filesize
 
Pagefile::filesizeStr()
stringReturns the filesize in a formatted, output-ready string (i.e. "123 kB")
Can also be used as property: Pagefile::filesizeStr
 
Pagefile::hash()
stringReturn a unique MD5 hash representing this Pagefile.
Can also be used as property: Pagefile::hash
 
Pagefile::httpUrl()
stringReturn the web accessible URL (with scheme and hostname) to this Pagefile.
Can also be used as property: Pagefile::httpUrl
Pagefile::name string Returns the filename without the path, same as the "basename" property. 
Pagefile::noCacheURL()
string
Pagefile::url()
stringReturn the web accessible URL to this Pagefile.
Can also be used as property: Pagefile::url
 

Traversal

For the most part you’ll want to traverse from the parent Pagefiles object than these methods.

NameReturnSummary 
Pagefile::getNext()
Pagefile Wire nullReturn the next sibling Pagefile in the parent Pagefiles, or NULL if at the end. 
Pagefile::getPrev()
Pagefile Wire nullReturn the previous sibling Pagefile in the parent Pagefiles, or NULL if at the beginning. 

Manipulation

Remember to follow up any manipulations with a $pages->save() call.

NameReturnSummary 
Pagefile::addTag($tag)
$thisAdd the given tag to this file’s tags (if not already present) 
Pagefile::description()
string arrayGet or set the file’s description (with multi-language support).
Can also be used as property: Pagefile::description
 
Pagefile::removeTag(string $tag)
$thisRemove the given tag from this file’s tags (if present) 
Pagefile::rename(string $basename)
string boolRename this file 
Pagefile::tags()
string arrayGet or set the "tags" property, when in use.
Can also be used as property: Pagefile::tags
 

Date time

NameReturnSummary 
Pagefile::created int Unix timestamp of when file was created.  
Pagefile::createdStr string Readable date/time string of when Pagefile was created  
Pagefile::modified int Unix timestamp of when Pagefile (file, description or tags) was last modified.  
Pagefile::modifiedStr string Readable date/time string of when Pagefile was last modified.  
Pagefile::mtime int Unix timestamp of when file (only) was last modified.  
Pagefile::mtimeStr string Readable date/time string when file (only) was last modified.  

For hooks

These methods are only useful for hooking and should not be called directly.

Tags

Be sure to see the Pagefiles::getTag() and Pagesfiles::findTag() methods, which enable you retrieve files by tag.

NameReturnSummary 
Pagefile::addTag($tag)
$thisAdd the given tag to this file’s tags (if not already present) 
Pagefile::hasTag(string $tag)
bool stringDoes this file have the given tag(s)? 
Pagefile::removeTag(string $tag)
$thisRemove the given tag from this file’s tags (if present) 
Pagefile::tags()
string arrayGet or set the "tags" property, when in use.
Can also be used as property: Pagefile::tags
 
Pagefile::tagsArray array Get file tags as an array.  

Other

NameReturnSummary 
Pagefile::HTTPURL string Same as the cache-busting uppercase “URL” property, but includes scheme and hostname.  
Pagefile::URL string Same as $url property but with browser cache busting query string appended.  
Pagefile::field Field The Field object that this file is part of.  
Pagefile::page Page The Page object that this file is part of.  
Pagefile::pagefiles Pagefiles The Pagefiles WireArray that contains this file.  

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.148

Twitter updates

  • Weekly update for Jan 10, 2020—front-end file uploads in LoginRegisterPro with InputfieldFrontendFile module: More
    10 January 2020
  • If you haven't seen it yet, be sure to check out this great infographic by @teppokoivula in ProcessWire Weekly #294— How ProcessWire professionals work—the results of our recent weekly polls summarised: weekly.pw/issue/294/#how…
    3 January 2020
  • Today we have a new master version released, 3.0.148! There are 25 new versions worth of upgrades, fixes and optimizations in this new master version, relative to the previous. In this post we take a closer look at what’s new, how to upgrade, & more— More
    3 January 2020

Latest news

  • ProcessWire Weekly #297
    In the 297th issue of ProcessWire Weekly we're going to check out the latest core updates (ProcessWire 3.0.149) and introduce a new third party module called StaticWire. Read on!
    Weekly.pw / 18 January 2020
  • ProcessWire 3.0.148 new master
    Today we have a new master version released, version 3.0.148! The last master version was 3.0.123, so there are 25 new versions worth of upgrades, fixes and optimizations in this new master version, relative to the previous. In this post we’ll take a closer look at what’s new, how to upgrade, and more.
    Blog / 3 January 2020
  • 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