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.

Common

Name	Return	Summary
PagesType::__construct() PagesType::__construct(ProcessWire $wire) PagesType::__construct(ProcessWire $wire, $templates = [], $parents = [])	(nothing)	Construct this PagesType manager for the given parent and template
PagesType::add() PagesType::add(string $name) PagesType::add(string $name)	`Page` `NullPage`	Adds a new page with the given $name and returns it
PagesType::count() PagesType::count() PagesType::count(string $selectorString = '', array $options = [])	`int`	Return the number of pages in this type matching the given selector string
PagesType::delete() PagesType::delete(Page $page) PagesType::delete(Page $page, bool $recursive = false)	`bool`	Permanently delete a page and its fields.
PagesType::find() PagesType::find(string $selectorString) PagesType::find(string $selectorString, array $options = [])	`PageArray`	Given a Selector string, return the Page objects that match in a PageArray.
PagesType::findIDs() PagesType::findIDs(string $selectorString) PagesType::findIDs(string $selectorString, array $options = [])	`array`	Given a Selector string, return the page IDs that match
PagesType::get() PagesType::get($selectorString) PagesType::get($selectorString)	`Page` `NullPage` `null`	Get the first match of your selector string
PagesType::save() PagesType::save(Page $page) PagesType::save(Page $page)	`bool`	Save a page object and its fields to database.

Family

Name	Return	Summary
PagesType::addParents() PagesType::addParents($parents) PagesType::addParents($parents)	(nothing)	Add one or more of parents that this PagesType represents
PagesType::addTemplates() PagesType::addTemplates($templates) PagesType::addTemplates($templates)	(nothing)	Add one or more templates that this PagesType represents
PagesType::getPageClass() PagesType::getPageClass() PagesType::getPageClass()	`string`	Get the PHP class name used by Page objects of this type
PagesType::getParent() PagesType::getParent() PagesType::getParent()	`Page` `NullPage`	Get the parent Page object (or first parent Page object if there are multiple)
PagesType::getParentID() PagesType::getParentID() PagesType::getParentID()	`int`	Get the parent page ID used by this type (or first parent ID if there are multiple)
PagesType::getParentIDs() PagesType::getParentIDs() PagesType::getParentIDs()	`array`	Get the parent page IDs used by this type
PagesType::getParents() PagesType::getParents() PagesType::getParents()	`PageArray`	Get the parent Page objects in a PageArray
PagesType::getTemplate() PagesType::getTemplate() PagesType::getTemplate()	`Template`	Get the template used by this type (or first template if there are multiple)
PagesType::getTemplates() PagesType::getTemplates() PagesType::getTemplates()	`array` `Template`	Get the templates (plural) used by this type
PagesType::setPageClass() PagesType::setPageClass(string $class) 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.

Name	Return	Summary
PagesType::added() PagesType::added(Page $page) PagesType::added(Page $page)	(nothing)	Hook called when a new page of this type has been added
PagesType::deleteReady() PagesType::deleteReady(Page $page) PagesType::deleteReady(Page $page)	(nothing)	Hook called when a page is about to be deleted, but before data has been touched
PagesType::deleted() PagesType::deleted(Page $page) PagesType::deleted(Page $page)	(nothing)	Hook called when a page and its data have been deleted
PagesType::saveReady() PagesType::saveReady(Page $page) PagesType::saveReady(Page $page)	`array`	Hook called just before a page of this type is saved
PagesType::saved() PagesType::saved(Page $page) PagesType::saved(Page $page, array $changes = [], array $values = [])	(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:

Wire

API reference based on ProcessWire core version 3.0.236

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

Common

Family

For hooks

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news