PageFinder class

Located in file /wire/core/PageFinder.php

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

Common

Name	Return	Summary
PageFinder::checkAccess	`bool`
PageFinder::count() PageFinder::count($selectors) PageFinder::count($selectors, array $options = [])	`int`	Return a count of pages that match
PageFinder::find() PageFinder::find($selectors) PageFinder::find($selectors, array $options = [])	`array` `DatabaseQuerySelect`	Return all pages matching the given selector.
PageFinder::findIDs() PageFinder::findIDs($selectors) PageFinder::findIDs($selectors, array $options = [])	`array`	Same as find() but returns just a simple array of page IDs without any other info
PageFinder::findParentIDs() PageFinder::findParentIDs($selectors) PageFinder::findParentIDs($selectors, array $options = [])	`array`	Same as findIDs() but returns the parent IDs of the pages that matched
PageFinder::findTemplateIDs() PageFinder::findTemplateIDs($selectors) PageFinder::findTemplateIDs($selectors, array $options = [])	`array`	Find template ID for each page — returns array of template IDs indexed by page ID
PageFinder::findVerboseIDs() PageFinder::findVerboseIDs($selectors) PageFinder::findVerboseIDs($selectors, array $options = [])	`array` `DatabaseQuerySelect`	Returns array of arrays with all columns in pages table indexed by page ID
PageFinder::getLimit() PageFinder::getLimit() PageFinder::getLimit()	`int`	Returns the limit placed upon the last find() operation, or 0 if no limit was specified
PageFinder::getOptions() PageFinder::getOptions() PageFinder::getOptions()	`array`	Return array of the options provided to PageFinder, as well as those determined at runtime
PageFinder::getPageArrayData() PageFinder::getPageArrayData() PageFinder::getPageArrayData($pageArray = null)	`array`	Get data that should be populated back to any resulting PageArray’s data() method
PageFinder::getParentID() PageFinder::getParentID() PageFinder::getParentID()	`int`	Returns the parent ID, if it was part of the selector
PageFinder::getQuery() PageFinder::getQuery($selectors, array $options) PageFinder::getQuery($selectors, array $options)	`DatabaseQuerySelect`
PageFinder::getQueryAllowedTemplatesWhere() PageFinder::getQueryAllowedTemplatesWhere(DatabaseQuerySelect $query, $where) PageFinder::getQueryAllowedTemplatesWhere(DatabaseQuerySelect $query, $where)	`string`
PageFinder::getQueryJoinPath() PageFinder::getQueryJoinPath(DatabaseQuerySelect $query, $selector) PageFinder::getQueryJoinPath(DatabaseQuerySelect $query, $selector)	(nothing)
PageFinder::getQueryUnknownField() PageFinder::getQueryUnknownField($fieldName, array $data) PageFinder::getQueryUnknownField($fieldName, array $data)	`bool` `Field`	;
PageFinder::getStart() PageFinder::getStart() PageFinder::getStart()	`int`	Returns the start placed upon the last find() operation
PageFinder::getTemplatesID() PageFinder::getTemplatesID() PageFinder::getTemplatesID()	`int` `null`	Returns the templates ID, if it was part of the selector
PageFinder::getTotal() PageFinder::getTotal() PageFinder::getTotal()	`int`	Returns the total number of results returned from the last find() operation
PageFinder::includeMode	`string`
PageFinder::syntaxError() PageFinder::syntaxError(string $message) PageFinder::syntaxError(string $message)	(nothing)	Throw a fatal syntax error

Additional methods and properties

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

Wire

API reference based on ProcessWire core version 3.0.236

Located in file /wire/core/PageFinder.php

Common

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news