Pages Loader

Implements page finding/loading methods for the $pages API variable.

Please always use $pages->method() rather than $pages->loader->method() in cases where there is overlap.

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

Settings

Name	Return	Summary
$pages->loader->getAutojoin() $pages->loader->getAutojoin() $pages->loader->getAutojoin()	`bool`	Get whether autojoin is enabled for page loading queries
$pages->loader->getOutputFormatting() $pages->loader->getOutputFormatting() $pages->loader->getOutputFormatting()	`bool`	Get whether loaded pages have their outputFormatting turned on or off
$pages->loader->setAutojoin() $pages->loader->setAutojoin() $pages->loader->setAutojoin(bool $autojoin = true)	None	Enable or disable use of autojoin for all queries
$pages->loader->setOutputFormatting() $pages->loader->setOutputFormatting() $pages->loader->setOutputFormatting(bool $outputFormatting = true)	None	Set whether loaded pages have their outputFormatting turned on or off

Retrieve

Name	Return	Summary
$pages->loader->count() $pages->loader->count() $pages->loader->count($selector = '', $options = [])	`int`	Count and return how many pages will match the given selector string
$pages->loader->find() $pages->loader->find($selector) $pages->loader->find($selector, $options = [])	`PageArray` `array`	Given a Selector string, return the Page objects that match in a PageArray.
$pages->loader->findByName() $pages->loader->findByName(string $name) $pages->loader->findByName(string $name, array $options = [])	`array` `NullPage` `Page` `PageArray`	Find page(s) by name
$pages->loader->findCache() $pages->loader->findCache($selector) $pages->loader->findCache($selector, $expire = 60, array $options = [])	`PageArray` `array`	Find pages and cache the result for specified period of time
$pages->loader->findMin() $pages->loader->findMin($selector) $pages->loader->findMin($selector, array $options = [])	`PageArray`	Minimal find for reduced or delayed overload in some circumstances
$pages->loader->findOne() $pages->loader->findOne($selector) $pages->loader->findOne($selector, $options = [])	`Page` `NullPage`	Like find() but returns only the first match as a Page object (not PageArray)
$pages->loader->get() $pages->loader->get($selector) $pages->loader->get($selector, array $options = [])	`Page` `NullPage`	Returns the first page matching the given selector with no exclusions
$pages->loader->getById() $pages->loader->getById($_ids) $pages->loader->getById($_ids, $template = null, $parent_id = null)	`PageArray` `Page` `NullPage`	Given an array or CSV string of Page IDs, return a PageArray
$pages->loader->getByPath() $pages->loader->getByPath(string $path) $pages->loader->getByPath(string $path, $options = [])	`Page` `int`	Get a page by its path, similar to $pages->get('/path/to/page/') but with more options
$pages->loader->getFresh() $pages->loader->getFresh($selectorOrPage) $pages->loader->getFresh($selectorOrPage, array $options = [])	`Page` `NullPage`	Get a fresh, non-cached copy of a Page from the database
$pages->loader->getNativeColumnValue() $pages->loader->getNativeColumnValue($id, string $column) $pages->loader->getNativeColumnValue($id, string $column)	`int` `string` `bool`	Get value of of a native column in pages table for given page ID
$pages->loader->getNumChildren() $pages->loader->getNumChildren($page) $pages->loader->getNumChildren($page)	`int`	Load total number of children from DB for given page
$pages->loader->getPath() $pages->loader->getPath($id) $pages->loader->getPath($id, $options = [])	`string`	Given an ID return a path to a page, without loading the actual page
$pages->loader->has() $pages->loader->has($selector) $pages->loader->has($selector, bool $verbose = false, array $options = [])	`array` `int`	Is there any page that matches the given $selector in the system? (with no exclusions)

Preload

Name	Return	Summary
$pages->loader->preloadAllFields() $pages->loader->preloadAllFields(Page $page) $pages->loader->preloadAllFields(Page $page, array $options = [])	`array`	Preload all supported fields for given page (experimental)
$pages->loader->preloadFields() $pages->loader->preloadFields(Page $page, array $fieldNames) $pages->loader->preloadFields(Page $page, array $fieldNames, array $options = [])	`array`	Preload/Prefetch fields for page together as a group (experimental)

Native

Name	Return	Summary
$pages->loader->getNativeColumnValue() $pages->loader->getNativeColumnValue($id, string $column) $pages->loader->getNativeColumnValue($id, string $column)	`int` `string` `bool`	Get value of of a native column in pages table for given page ID
$pages->loader->getNativeColumns() $pages->loader->getNativeColumns() $pages->loader->getNativeColumns()	`array`	Returns an array of all columns native to the pages table
$pages->loader->isNativeColumn() $pages->loader->isNativeColumn($columnName) $pages->loader->isNativeColumn($columnName)	`bool`	Is the given column name native to the pages table?

Debug

Name	Return	Summary
$pages->loader->debug() $pages->loader->debug() $pages->loader->debug($debug = null)	`bool`	Get or set debug state
$pages->loader->getLastPageFinder() $pages->loader->getLastPageFinder() $pages->loader->getLastPageFinder()	`PageFinder` `null`	Get last used instance of PageFinder (for debugging purposes)

Info

Name	Return	Summary
$pages->loader->getTotalPagesLoaded() $pages->loader->getTotalPagesLoaded() $pages->loader->getTotalPagesLoaded()	`int`	Return the total quantity of pages loaded by getById()
$pages->loader->isLoading() $pages->loader->isLoading() $pages->loader->isLoading()	`bool`	Are we currently loading pages?

Additional methods and properties

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

Wire

API reference based on ProcessWire core version 3.0.252