PagesRequest::getClosestPage() method

Get closest matching page when getPage() returns an error/NullPage

This is useful for a 404 page to suggest if maybe the user intended a different page and give them a link to it. For instance, you might have the following code in the template file used by your 404 page:

Example

echo "<h1>404 Page Not Found</h1>";
$p = $pages->request()->getClosestPage();
if($p->id) {
  echo "<p>Are you looking for <a href='$p->url'>$p->title</a>?</p>";
}

Usage

$page = $pagesRequest->getClosestPage();

Return value


Hooking PagesRequest::getClosestPage()

You can add your own hook events that are executed either before or after the PagesRequest::getClosestPage() 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 PagesRequest::getClosestPage() method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

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

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
});

Hooking after

The 'after' hooks are called immediately after each PagesRequest::getClosestPage() method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

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

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

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

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

PagesRequest methods and properties

API reference based on ProcessWire core version 3.0.200

Twitter updates

  • Weekly update: Smooth rollout for ProcessWire 3.0.200 main/master, plus getting started on a new WP-to-PW site conversion and why they can be so rewarding— More
    20 May 2022
  • New main/master version of ProcessWire that has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release— More
    13 May 2022
  • Summary of weekly core updates for 22 April 2022 More
    22 April 2022

Latest news

  • ProcessWire Weekly #419
    In issue 419 of ProcessWire Weekly we'll check out this week's core updates, introduce a brand new recipe of the week, and more. Read on!
    Weekly.pw / 21 May 2022
  • ProcessWire 3.0.200 new master/main version
    This new main/master version has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release. This post covers all the details.
    Blog / 13 May 2022
  • 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