PagePathHistory class

Keeps track of past URLs where pages have lived and automatically redirects (301 permament) 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?        

Common

NameReturnSummary 
PagePathHistory::addPathHistory(Page $page, string $path)
boolAdd a history path for a page 
PagePathHistory::deleteAllPathHistory($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 
PagePathHistory::getRootSegments()
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.200

Twitter updates

  • Weekly update: Smooth rollout for ProcessWire 3.0.200 main/master, plus getting started on a new WP-to-PW site conversion and why they can be so rewarding— More
    20 May 2022
  • New main/master version of ProcessWire that has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release— More
    13 May 2022
  • Summary of weekly core updates for 22 April 2022 More
    22 April 2022

Latest news

  • ProcessWire Weekly #419
    In issue 419 of ProcessWire Weekly we'll check out this week's core updates, introduce a brand new recipe of the week, and more. Read on!
    Weekly.pw / 21 May 2022
  • ProcessWire 3.0.200 new master/main version
    This new main/master version has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release. This post covers all the details.
    Blog / 13 May 2022
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH