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
to true. Note that it will only apply to matched pages that have templates allowing URL
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
matchType properties may only be of interest if the
allowUrlSegments option is set to
Available since version 3.0.186.
// basic usage $array = $pagePathHistory->getPathInfo(string $path); // usage with all arguments $array = $pagePathHistory->getPathInfo(string $path, array $options = );
API reference based on ProcessWire core version 3.0.200