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::filemtime()
intGet last modified time of file 
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::isNew()
boolGet or set “new” status of the Pagefile 
Pagefile::name string Returns the filename without the path, same as the "basename" property. 
Pagefile::noCacheURL()
string
Pagefile::save()
boolSave this Pagefile independently of the Page it lives on 
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::filedata()
mixedGet or set filedata
Can also be used as property: Pagefile::filedata
 
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::createdUser User NullPage User that added/uploaded the file or NullPage if not known (3.0.154)+.  
Pagefile::created_users_id int ID of user that added/uploaded the file or 0 if not known (3.0.154+).  
Pagefile::field Field The Field object that this file is part of.  
Pagefile::modifiedUser User NullPage User that last modified the file or NullPage if not known (3.0.154)+.  
Pagefile::modified_users_id int ID of user that last modified the file or 0 if not known (3.0.154+).  
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.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

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer