$pages API variable / Pages class

Enables loading and manipulation of Page objects, to and from the database.

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

Show $var?             Show args?        

Retrieval

NameReturnSummary 
$pages->count()
intCount and return how many pages will match the given selector. 
$pages->find($selector)
PageArray arrayGiven a Selector string, return the Page objects that match in a PageArray.
$pages->findIDs($selector)
arrayLike find() except returns array of IDs rather than Page objects 
$pages->findMany($selector)
PageArrayLike find(), but with “lazy loading” to support giant result sets without running out of memory. 
$pages->findOne($selector)
Page NullPageLike find() but returns only the first match as a Page object (not PageArray). 
$pages->get($selector)
Page NullPageReturns the first page matching the given selector with no exclusions 
$pages->getByIDs($ids)
PageArray PageGiven array or CSV string of Page IDs, return a PageArray 
$pages->getID($selector)
int string arrayGet one ID of page matching given selector with no exclusions, like get() but returns ID rather than a Page 
$pages->has($selector)
array intIs there any page that matches the given $selector in the system? (with no exclusions) 

Advanced

NameReturnSummary 
$pages->getByPath(string $path)
Page intGet a page by its path, similar to $pages->get('/path/to/page/') but with more options 
$pages->getPath($id)
stringGiven an ID, return a path to a page, without loading the actual page 
$pages->insertAfter(Page $page, Page $afterPage)
(nothing)Sort/move one page after another (for manually sorted pages)
$pages->insertBefore(Page $page, Page $beforePage)
(nothing)Sort/move one page above another (for manually sorted pages)
$pages->names()
PagesNamesGet Pages API methods specific to generating and modifying page names 
$pages->of()
boolGet or set the current output formatting state 
$pages->sort(Page $page)
intSet the “sort” value for given $page while adjusting siblings, or re-build sort for its children
$pages->uncacheAll()
intRemove all pages from the cache (to clear memory) 

For hooks

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

NameReturnSummary 
$pages->added(Page $page)
(nothing)Hook called after a new page has been added
$pages->cloneReady(Page $page, Page $copy)
(nothing)Hook called when a page is about to be cloned, but before data has been touched
$pages->cloned(Page $page, Page $copy)
(nothing)Hook called when a page has been cloned
$pages->deleteReady(Page $page)
(nothing)Hook called when a page is about to be deleted, but before data has been touched
$pages->deleted(Page $page)
(nothing)Hook called after a page and its data have been deleted
$pages->found(PageArray $pages, array $details)
(nothing)Hook called at the end of a $pages->find(), includes extra info not seen in the resulting PageArray
$pages->moved(Page $page)
(nothing)Hook called when a page has been moved from one parent to another
$pages->publishReady(Page $page)
(nothing)Hook called right before an unpublished page is published and saved
$pages->published(Page $page)
(nothing)Hook called after an unpublished page has just been published
$pages->renamed(Page $page)
(nothing)Hook called when a page has been renamed (i.e. had its name field change)
$pages->restored(Page $page)
(nothing)Hook called when a page has been moved OUT of the trash (restored)
$pages->saveFieldReady(Page $page, Field $field)
(nothing)Hook called when Pages::saveField is ready to execute
$pages->savePageOrFieldReady(Page $page)
(nothing)Hook called when either of Pages::save or Pages::saveField is ready to execute
$pages->saveReady(Page $page)
arrayHook called just before a page is saved
$pages->saved(Page $page)
(nothing)Hook called after a page is successfully saved
$pages->savedField(Page $page, Field $field)
(nothing)Hook called after Pages::saveField successfully executes
$pages->savedPageOrField(Page $page)
(nothing)Hook called after either of Pages::save or Pages::saveField successfully executes
$pages->sorted(Page $page)
(nothing)Hook called after a page has been sorted, or had its children re-sorted
$pages->statusChangeReady(Page $page)
(nothing)Hook called when a page's status is about to be changed and saved
$pages->statusChanged(Page $page)
(nothing)Hook called when a page status has been changed and saved
$pages->templateChanged(Page $page)
(nothing)Hook called when a page's template has been changed
$pages->trashed(Page $page)
(nothing)Hook called when a page has been moved to the trash
$pages->unpublishReady(Page $page)
(nothing)Hook called right before a published page is unpublished and saved
$pages->unpublished(Page $page)
(nothing)Hook called after published page has just been unpublished

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.160

Twitter updates

  • ProcessWire 3.0.161 adds support for selector operator stacking, enabling you automatically broaden searches in a single pages.find() call— More
    26 June 2020
  • ProcessWire 3.0.160 adds powerful new text-searching operators, bringing a new level of power to page-finding API calls, especially when it comes to search engine type queries. Post also includes a demo search engine where you can test it all out live— More
    19 June 2020
  • Preview of ProcessWire 3.0.160 with auto-enable of two-factor authentication, new version of TfaEmail and TfaTotp, and new selector operators coming next week. More
    12 June 2020

Latest news

  • ProcessWire Weekly #319
    In the 319th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a couple of new third party modules, and highlight the downright stunning new website of Studio Pixelgold. Read on!
    Weekly.pw / 21 June 2020
  • Powerful new text-searching abilities in 3.0.160
    In ProcessWire 3.0.160 we’ve got some major upgrades and additions to our text-search abilities. This brings a whole new level of power to $pages->find() and similar API calls, especially when it comes to search engine type queries.
    Blog / 19 June 2020
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull