PagePathHistory::setPathHistory()

Set a history path for a page and delete any existing entries for page’s current path

Usage

// basic usage
$bool = $pagePathHistory->setPathHistory(Page $page, string $path);

// usage with all arguments
$bool = $pagePathHistory->setPathHistory(Page $page, string $path, $language = null);

Arguments

Name	Type(s)	Description
`$page`	`Page`
`$path`	`string`
`$language` (optional)	`Language` `int`

Return value

bool

True on success, or false if path already consumed in history

PagePathHistory methods and properties

API reference based on ProcessWire core version 3.0.253