PagesVersions::renamePageVersion() method

Rename a page version

Available since version 3.0.258.

Example

// give version 2 a name
$pagesVersions->renamePageVersion($page, 2, 'draft');

// rename using the existing name
$pagesVersions->renamePageVersion($page, 'draft', 'backup');

// clear the name from a version
$pagesVersions->renamePageVersion($page, 'draft', null);

Usage

$bool = $pagesVersions->renamePageVersion(Page $page, $version, $newName);

Arguments

Name	Type(s)	Description
`$page`	`Page`
`$version`	`int` `string`	Version number or name
`$newName`	`string` `null`	New name or null to remove name

Return value

bool

True on success, false if version not found

$pagesVersions methods and properties

API reference based on ProcessWire core version 3.0.257