$pages->find() method

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.

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

NameType(s)Description
selectorstring, 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 (default=true, except when findOne=true).
  • loadPages (bool): Whether to populate the returned PageArray with found pages (default=true). 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.
  • cache (bool): Allow caching of selectors and loaded pages? (default=true). Also sets loadOptions[cache].
  • 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'. (default=none). Typically you would specify this directly in the selector string, so the option is mainly useful if your first argument is not a string.
  • 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).

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.


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;
});

See Also


$pages methods and properties

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 #320
    In the 320th issue of ProcessWire Weekly we're going to check out the latest core updates (ProcessWire 3.0.161), a new third party module called Fieldtype Runtime only, an IndieWeb themed article from Francesco Schwarz, and more. Read on!
    Weekly.pw / 27 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

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer