PagesVersions::savePageVersion() method

Save a page version

Usage

// basic usage
$int = $pagesVersions->savePageVersion(Page $page);

// usage with all arguments
$int = $pagesVersions->savePageVersion(Page $page, $version = 0, array $options = []);

Arguments

Name Type(s) Description

page Page

Name	Type(s)	Description
`page`	Page
`version` (optional)	int, PageVersionInfo	Version number or PageVersionInfo If given version number is greater than 0 and version doesn't exist, it will be added. If 0 or omitted and given page is already a version, its version will be updated. If 0 or omitted and given page is not a version, this method behaves the same as the `addPageVersion()` method and returns the added version number.
`options` (optional)	array	`description` (string): Optional text description for version (default='') `update` (bool): Update version if it already exists (default=true)

version (optional)

int, PageVersionInfo

Version number or PageVersionInfo

If given version number is greater than 0 and version doesn't exist, it will be added.
If 0 or omitted and given page is already a version, its version will be updated.
If 0 or omitted and given page is not a version, this method behaves the same as the addPageVersion() method and returns the added version number.

options (optional)

array

description (string): Optional text description for version (default='')
update (bool): Update version if it already exists (default=true)

Return value

int array

Returns version number saved or added or 0 on fail

Exceptions

Method can throw exceptions on error:

WireException or \PDOException

$pagesVersions methods and properties

API reference based on ProcessWire core version 3.0.244

PagesVersions::savePageVersion() method

Save a page version

Usage

Arguments

Return value

Exceptions

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news