PagesPathFinder class

Enables finding pages by path, optionally with URL segments, pagination numbers, language prefixes, etc.

This is built for use by the PagesRequest class and ProcessPageView module, but can also be useful from the public API. The most useful method is the get() method which returns a verbose array of information about the given path. Methods in this class should be acessed from $pages->pathFinder(), i.e.

$result = $pages->pathFinder()->get('/en/foo/bar/page3');

Note that PagesPathFinder does not perform any access control checks, so if using this class then validate access afterwards when appropriate.


Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the PagesPathFinder class also inherits all the methods and properties of: Wire.

Show class?             Show args?        

Additional methods and properties

In addition to the methods and properties above, PagesPathFinder also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #550
    In the 550th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module called PagefileMetadata, and more. Read on!
    Weekly.pw / 23 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits