$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.163

Twitter updates

  • Quick weekly update covering this week's commits for the upcoming 3.0.167 ProcessWire core version— More
    18 September 2020
  • This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder— More
    11 September 2020
  • Weekly update – 28 August 2020 – New secure files option defined per-template: More
    28 August 2020

Latest news

  • ProcessWire Weekly #332
    In the 332nd issue of ProcessWire Weekly we'll cover the latest core updates, introduce some new and updated ProcessWire resources, and more. Read on!
    Weekly.pw / 19 September 2020
  • ProcessWire 3.0.166 core updates and more
    This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder.
    Blog / 11 September 2020
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK