PagesSortfields class

Manages the table for the sortfield property for Page children.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the PagesSortfields class also inherits all the methods and properties of: Wire.

Common

Name	Return	Summary
PagesSortfields::decode() PagesSortfields::decode($sortfield) PagesSortfields::decode($sortfield, string $default = 'sort')	`string`	Decodes a sortfield from a signed integer or string to a field name
PagesSortfields::delete() PagesSortfields::delete($page) PagesSortfields::delete($page)	`bool`	Delete the sortfield for a given Page
PagesSortfields::encode() PagesSortfields::encode(string $sortfield) PagesSortfields::encode(string $sortfield, string $default = 'sort')	`string` `int`	Encodes a sortfield from a fieldname to a signed integer (ID) representing a custom field, or native field name
PagesSortfields::get() PagesSortfields::get($page) PagesSortfields::get($page)	`string`	Get sortfield for given Page from DB
PagesSortfields::save() PagesSortfields::save($page) PagesSortfields::save($page)	`bool`	Save the sortfield for a given Page

Additional methods and properties

In addition to the methods and properties above, PagesSortfields also inherits the methods and properties of these classes:

Wire

API reference based on ProcessWire core version 3.0.251