Return all pages matching the given selector.
Usage
// basic usage
$array = $pageFinder->find($selectors);
// usage with all arguments
$array = $pageFinder->find($selectors, array $options = []);Arguments
| Name | Type(s) | Description |
|---|---|---|
selectors | Selectors, string, array | Selectors object, selector string or selector array |
options (optional) | array |
|
Return value
array DatabaseQuerySelect
Exceptions
Method can throw exceptions on error:
PageFinderException
Hooking PageFinder::find(…)
You can add your own hook events that are executed either before or after the Page 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 Page method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('PageFinder::find', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$PageFinder = $event->object;
// Get values of arguments sent to hook (and optionally modify them)
$selectors = $event->arguments(0);
$options = $event->arguments(1);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $selectors);
$event->arguments(1, $options);
}); Hooking after
The 'after' hooks are called immediately after each Page method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.
$this->addHookAfter('PageFinder::find', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$PageFinder = $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)
$selectors = $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;
}); PageFinder methods and properties
API reference based on ProcessWire core version 3.0.244