PagePathHistory::getPathInfo() method

Get array of info about a path if it is in history

If path is found in history, the returned array id value will be populated with a positive integer of the found page ID. If not found, it will be populated with integer 0.

By default this method attempts to perform exact path matches only. To enable partial matches of paths that may be appended with additional URL segments, set the allowUrlSegments option to true. Note that it will only apply to matched pages that have templates allowing URL segments.

Return array includes:

  • id (int): ID of matched page or 0 if no match.
  • path (string): Path that was matched.
  • language_id (int): ID of language for path, if applicable.
  • templates_id (int): ID of template for page that was matched.
  • `parent_id (int): ID of parent for page that was matched.
  • status (int): Status of the page that was matched.
  • created (string): Date that this entry was created (ISO-8601 date/time string).
  • name (string): Name of page that was matched in default language.
  • urlSegmentStr (string): Portion of path that was identified as URL segments (for partial match).
  • matchType (string): Contains value “exact” when exact match, “partial” when partial/URL segments match, or blank string when no match.

Note that the urlSegmentStr and matchType properties may only be of interest if the given allowUrlSegments option is set to true.

Available since version 3.0.186.

Usage

// basic usage
$array = $pagePathHistory->getPathInfo(string $path);

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

Arguments

NameType(s)Description
pathstring
options (optional)array
  • allowUrlSegments (bool): Allow matching paths with URL segments? (default=false) When used, the urlSegmentStr return value property will be populated with slash separated URL segments that were not part of the matched path, and the matchType property will contain the value “partial”.

Return value

array


PagePathHistory methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #552
    In the 552nd issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, take a quick look at a new e-commerce solution for ProcessWire, and more. Read on!
    Weekly.pw / 7 December 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

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani