$pages→find()

Given a Selector string, return the Page objects that match in a PageArray.

This is one of the most commonly used API methods in ProcessWire.
If you only need to find one page, use the Pages::get() or Pages::findOne() method instead (and note the difference).
If you need to find a huge quantity of pages (like thousands) without limit or pagination, look at the Pages::findMany() method.

Non-visible pages are excluded unless an include=x mode is specified in the selector, where x is hidden, unpublished or all. If all is specified, then non-accessible pages (via access control) can also be included.

Example

// Find all pages using template "building" with 25 or more floors
$skyscrapers = $pages->find("template=building, floors>=25");

Usage

// basic usage
$items = $pages->find($selector);

// usage with all arguments
$items = $pages->find($selector, $options = []);

Arguments

Name Type(s) Description

Name	Type(s)	Description
`$selector`	`string` `int` `array` `Selectors`	Specify selector (standard usage), but can also accept page ID or array of page IDs.
`$options` (optional)	`array` `string`	One or more options that can modify certain behaviors. May be associative array or "key=value" selector string. `findOne` (bool): Apply optimizations for finding a single page Default:false `findAll` (bool): Find all pages with no exclusions, same as "include=all" option Default:false `findIDs` (bool\|int): 1 to get array of page IDs, true to return verbose array, 2 to return verbose array with all cols in 3.0.153+. Default:false `getTotal` (bool): Whether to set returning PageArray's "total" property when finding multiple pages. Default:true `loadPages` (bool): Whether to populate the returned PageArray with found pages. The only reason why you'd want to change this to false would be if you only needed the count details from the PageArray: getTotal(), getStart(), getLimit, etc. This is intended as an optimization for $pages->count(). Does not apply if $selector argument is an array. Default:true `cache` (bool): Allow caching of selectors and loaded pages? Also sets loadOptions[cache]. Default:true `allowCustom` (boolean): Allow use of _custom="another selector" in given $selector? For specific uses. Default:false `caller` (string): Optional name of calling function, for debugging purposes, i.e. "pages.count" Default:blank `include` (string): Optional inclusion mode of 'hidden', 'unpublished' or 'all'. Typically you would specify this directly in the selector string, so the option is mainly useful if your first argument is not a string. Default:none `stopBeforeID` (int): Stop loading pages once page matching this ID is found Default:0 `startAfterID` (int): Start loading pages once page matching this ID is found Default:0 `lazy` (bool): Specify true to force lazy loading. This is the same as using the Pages::findMany() method Default:false `loadOptions` (array): Optional associative array of options to pass to getById() load options.

$selector

string int array Selectors

Specify selector (standard usage), but can also accept page ID or array of page IDs.

$options (optional)

array string

One or more options that can modify certain behaviors. May be associative array or "key=value" selector string.

findOne (bool): Apply optimizations for finding a single page Default:false
findAll (bool): Find all pages with no exclusions, same as "include=all" option Default:false
findIDs (bool|int): 1 to get array of page IDs, true to return verbose array, 2 to return verbose array with all cols in 3.0.153+. Default:false
getTotal (bool): Whether to set returning PageArray's "total" property when finding multiple pages. Default:true
loadPages (bool): Whether to populate the returned PageArray with found pages. The only reason why you'd want to change this to false would be if you only needed the count details from the PageArray: getTotal(), getStart(), getLimit, etc. This is intended as an optimization for $pages->count(). Does not apply if $selector argument is an array. Default:true
cache (bool): Allow caching of selectors and loaded pages? Also sets loadOptions[cache]. Default:true
allowCustom (boolean): Allow use of _custom="another selector" in given $selector? For specific uses. Default:false
caller (string): Optional name of calling function, for debugging purposes, i.e. "pages.count" Default:blank
include (string): Optional inclusion mode of 'hidden', 'unpublished' or 'all'. Typically you would specify this directly in the selector string, so the option is mainly useful if your first argument is not a string. Default:none
stopBeforeID (int): Stop loading pages once page matching this ID is found Default:0
startAfterID (int): Start loading pages once page matching this ID is found Default:0
lazy (bool): Specify true to force lazy loading. This is the same as using the Pages::findMany() method Default:false
loadOptions (array): Optional associative array of options to pass to getById() load options.

Return value

PageArray array

PageArray of that matched the given selector, or array of page IDs (if using findIDs option).

Hooking $pages→find(…)

You can add your own hook events that are executed either before or after the $pages->find(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each $pages->find(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('Pages::find', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $pages = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $selector = $event->arguments(0);
  $options = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $selector);
  $event->arguments(1, $options);
});

Hooking after

The 'after' hooks are called immediately after each $pages->find(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Pages::find', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $pages = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $selector = $event->arguments(0);
  $options = $event->arguments(1);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});