$pages->getInfoByPath() method

Get verbose array of info about a given page path

This method accepts a page path (not URL) with optional language segment prefix, additional URL segments and/or pagination number. It translates the given path to information about what page it matches, what type of request it would result in.

If the response property in the return value is 301 or 302, then the redirect property will be populated with a recommend redirect path.

If given a $path argument of /en/foo/bar/page3 on a site that has default language homepage segment of en, a page living at /foo/ that accepts URL segment bar and has pagination enabled, it will return the following:

Example

[
  'request' => '/en/foo/bar/page3',
  'response' => 200, // one of 200, 301, 302, 404, 414
  'type' => 'ok', // response type name
  'errors' => [], // array of error messages indexed by error name
  'redirect' => '/redirect/path/', // suggested path to redirect to or blank
  'page' => [
     'id' => 123, // ID of the page that was found
     'parent_id' => 456,
     'templates_id' => 12,
     'status' => 1,
     'name' => 'foo',
  ],
  'language' => [
     'name' => 'default', // name of language detected
     'segment' => 'en', // segment prefix in path (if any)
     'status' => 1, // language status where 1 is on, 0 is off
   ],
  'parts' => [ // all the parts of the path identified
    [
      'type' => 'language',
      'value' => 'en',
      'language' => 'default'
    ],
    [
      'type' => 'pageName',
      'value' => 'foo',
      'language' => 'default'
    ],
    [
      'type' => 'urlSegment',
      'value' => 'bar',
      'language' => ''
    ],
    [
      'type' => 'pageNum',
      'value' => 'page3',
      'language' => 'default'
    ],
  ],
  'urlSegments' => [ // URL segments identified in order
     'bar',
  ],
  'urlSegmentStr' => 'bar', // URL segment string
  'pageNum' => 3, // requested pagination number
  'pageNumPrefix' => 'page', // prefix used in pagination number
  'scheme' => 'https', // blank if no scheme required, https or http if one of those is required
  'method' => 'pagesRow', // method(s) that were used to find the page
]

Usage

// basic usage
$array = $pages->getInfoByPath(string $path);

// usage with all arguments
$array = $pages->getInfoByPath(string $path, array $options = []);

Arguments

NameType(s)Description
pathstring

Page path optionally including URL segments, language prefix, pagination number

options (optional)array
  • useLanguages (bool): Allow use of multi-language page names? (default=true) Requires LanguageSupportPageNames module installed.
  • useShortcuts (bool): Allow use of shortcut methods for optimization? (default=true) Recommend PagePaths module installed.
  • useHistory (bool): Allow use historical path names? (default=true) Requires PagePathHistory module installed.
  • verbose (bool): Return verbose array of information? (default=true) If false, some optional information will be omitted in return value.

Return value

array


$pages methods and properties

API reference based on ProcessWire core version 3.0.200

Twitter updates

  • Stumbling upon a really nice ProcessWire-powered website, plus core updates including API improvements for ProcessWire forms— More
    9 September 2022
  • Useful new dot-and-bracket syntax options added for page.get() method— More
    2 September 2022
  • This week, in addition to the regular core updates, we have new versions of ProcessWire ProFields Table and ProFields Combo that add support for their own file and image types— More
    19 August 2022

Latest news

  • ProcessWire Weekly #437
    In the 437th issue of ProcessWire Weekly we're going to check out the latest core updates, forum highlights and online resources, and more. Read on!
    Weekly.pw / 24 September 2022
  • Multi-language field translation export/import
    In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire.
    Blog / 5 August 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