PagePathHistory class

Keeps track of past URLs where pages have lived and automatically redirects (301 permanent) to the new location whenever the past URL is accessed.

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

Show class?             Show args?        


PagePathHistory::addPathHistory(Page $page, string $path)
boolAdd a history path for a page 
(nothing)Delete all path history for a given Page or for all pages 
PagePathHistory::deletePathHistory(Page $page, string $path)
intDelete path entry for given page and path 
PagePathHistory::getPage(string $path)
Page NullPageGiven a previously existing path, return the matching Page object or NullPage if not found. 
PagePathHistory::getPathHistory(Page $page)
arrayGet an array of all paths the given page has previously had, oldest to newest 
PagePathHistory::getPathInfo(string $path)
arrayGet array of info about a path if it is in history 
arrayGet all root segments 
PagePathHistory::isRootSegment(string $segment)
boolIs/was given segment ever a root segment? 
PagePathHistory::minimumAge int 
PagePathHistory::rootSegments array bool 
PagePathHistory::setPathHistory(Page $page, string $path)
boolSet a history path for a page and delete any existing entries for page’s current path 
PagePathHistory::upgrade(int $fromVersion, int $toVersion)
(nothing)Upgrade PagePathHistory module schema

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.228

Latest news

  • ProcessWire Weekly #499
    In the 499th issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module called RockPdf, and more. Read on! / 3 December 2023
  • Using date range fields in ProcessWire
    This week we'll take a detailed look at the newest addition to the ProFields set of modules: the Date Range Fieldtype and Inputfield.
    Blog / 24 November 2023
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull