PagesType class

Provides an interface to the Pages class but specific to a given page class/type, with predefined parent and template.

This class is primarily used by the core as an alternative to $pages, providing an API for other Page types like User, Role, Permission, and Language. The $users, $roles, $permissions and $languages API variables are all instances of PagesType. This class is typically not instantiated on its own and instead acts as a base class which is extended.


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

Show class?             Show args?        

Family

NameReturnSummary 
PagesType::addParents($parents)
(nothing)Add one or more of parents that this PagesType represents 
PagesType::addTemplates($templates)
(nothing)Add one or more templates that this PagesType represents 
PagesType::getPageClass()
stringGet the PHP class name used by Page objects of this type 
PagesType::getParent()
Page NullPageGet the parent Page object (or first parent Page object if there are multiple) 
PagesType::getParentID()
intGet the parent page ID used by this type (or first parent ID if there are multiple) 
PagesType::getParentIDs()
arrayGet the parent page IDs used by this type 
PagesType::getParents()
PageArrayGet the parent Page objects in a PageArray 
PagesType::getTemplate()
TemplateGet the template used by this type (or first template if there are multiple) 
PagesType::getTemplates()
array TemplateGet the templates (plural) used by this type 
PagesType::setPageClass(string $class)
(nothing)Set the PHP class name to use for Page objects of this type 

For hooks

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

NameReturnSummary 
PagesType::added(Page $page)
(nothing)Hook called when a new page of this type has been added
PagesType::deleteReady(Page $page)
(nothing)Hook called when a page is about to be deleted, but before data has been touched
PagesType::deleted(Page $page)
(nothing)Hook called when a page and its data have been deleted
PagesType::saveReady(Page $page)
arrayHook called just before a page of this type is saved
PagesType::saved(Page $page)
(nothing)Hook called after a page of this type is successfully saved

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.184

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 #384
    In the 384th issue of ProcessWire Weekly we'll cover the latest core updates, introduce a new module called Session Allow, and highlight a new site of the week. Read on!
    Weekly.pw / 18 September 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

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH