PagesEditor::editor method

Save the manual 'sort' value for given page only

This is an internal method not part of the public API. Note that when $page is passed as an integer ID, the Pages::sorted hook is intentionally not called, providing a lightweight way to save sort without triggering hooks.

Available since version 3.0.258.

Usage

// basic usage
$bool = $pages->editor->saveSort($page);

// usage with all arguments
$bool = $pages->editor->saveSort($page, $sort = false);

Arguments

NameType(s)Description
$pagePage int

Page instance or Page ID (int). Pass int to skip the sorted hook.

$sort (optional)int false

Specify sort value or omit to use existing $page->sort value

Return value

bool

Returns true if row for page was updated, false if not


$pages->editor methods and properties

API reference based on ProcessWire core version 3.0.261