PagefilesManager class

Manages files and file directories for a page independent of a particular field.

Files in ProcessWire are always connected with a particular Field on a Page. This is typically a FieldtypeFile field or a FieldtypeImage field, which exist as Pagefiles or Pageimages values on the Page. Sometimes it is necessary to manage all files connected with a page as a group, and this files manager class provides that. Likewise, something needs to manage the paths and URLs where these files live, and that is where this files manager comes into play as well.

Summary of what PagefilesManager does

  • Provides methods for movement of all files connected with a page as a group.
  • Ensures that file directories for a page are created (and removed) when applicable.
  • Manages secured vs. normal page file paths (see $config->pagefileSecure).
  • Manages extended vs. normal page file paths (see $config->pagefileExtendedPaths).

How to access the Page files manager

The Page files manager can be accessed from any page’s Page::filesManager() method or property.

// Example of getting a Page’s dedicated file path and URL
$filesPath = $page->filesManager->path();
$filesURL = $page->filesManager->url();

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

Show class?             Show args?        

Common

NameReturnSummary 
PagefilesManager::getFile(string $name)
Pagefile Pageimage nullGet the Pagefile object containing the given filename. 
PagefilesManager::getFiles()
arrayGet an array of all published filenames on the current Page. 
PagefilesManager::getTempPath()
stringReturn a path where temporary files can be stored unique to this ProcessWire instance 
PagefilesManager::page Page Page that this files manager is for.  
PagefilesManager::path()
stringGet the published path for files
Can also be used as property: PagefilesManager::path
 
PagefilesManager::url()
stringGet the published URL for files
Can also be used as property: PagefilesManager::url
 

For hooks

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

NameReturnSummary 
PagefilesManager::save()
(nothing)For hooks to listen to on page save action, for file-specific operations

Static

These methods are not connected with a particular instance and may only be called statically.

NameReturnSummary 
PagefilesManager::dirToPageID(string $dir)
intGiven a dir (URL or path) to a files directory, return the page ID associated with it. 
PagefilesManager::hasFiles(Page $page)
boolReturns true if Page has a path and files, false if not. 
PagefilesManager::hasPath(Page $page)
boolReturns true if Page has a files path that exists. 

Additional methods and properties

In addition to the methods and properties above, PagefilesManager 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

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