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 Pages
Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Pages
class also inherits all the methods and properties of: Wire.
Common
Name | Return | Summary | |
---|---|---|---|
Pages Pages Pages | array | Get verbose array of info about a given page path | |
Pages Pages Pages | NullPage Page | Given a path, get a Page object or NullPage if not found |
Additional methods and properties
In addition to the methods and properties above, Pages
API reference based on ProcessWire core version 3.0.244