PageFrontEdit class

Class PageFrontEdit

Enables front-end editing of page fields.

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

Common

Name	Return	Summary
PageFrontEdit::inlineHookFormatValue() PageFrontEdit::inlineHookFormatValue(HookEvent $event) PageFrontEdit::inlineHookFormatValue(HookEvent $event)	None	Hook to Fieldtype::formatValue
PageFrontEdit::inlineIsEditable() PageFrontEdit::inlineIsEditable(Page $page, Field $field) PageFrontEdit::inlineIsEditable(Page $page, Field $field)	`bool`	Is the given page and field editable on the front-end?
PageFrontEdit::inlineIsSaveable() PageFrontEdit::inlineIsSaveable(Page $page, Field $field) PageFrontEdit::inlineIsSaveable(Page $page, Field $field)	`bool`	Is the given page and field saveable on the front-end?
PageFrontEdit::inlineSupported() PageFrontEdit::inlineSupported(Field $field) PageFrontEdit::inlineSupported(Field $field)	`bool`	Is inline mode supported for the given field?
PageFrontEdit::renderAssets() PageFrontEdit::renderAssets() PageFrontEdit::renderAssets()	`string`	Render markup output for javascripts and editor interface
PageFrontEdit::setPage() PageFrontEdit::setPage(Page $page) PageFrontEdit::setPage(Page $page)	None	Set the page being edited

For hooks

These methods are only useful for hooking and should not be called directly.

Name	Return	Summary
PageFrontEdit::getAjaxPostUrl() PageFrontEdit::getAjaxPostUrl() PageFrontEdit::getAjaxPostUrl()	`string`	Get URL that ajax save should post to
PageFrontEdit::getPage() PageFrontEdit::getPage() PageFrontEdit::getPage()	`Page` `null`	Get the page being edited or null if not yet set

Properties

Name	Return	Summary
PageFrontEdit::buttonLocation	`string`
PageFrontEdit::buttonType	`string`
PageFrontEdit::editRegionAttr	`string`
PageFrontEdit::editRegionTag	`string`
PageFrontEdit::inlineAllowFieldtypes	`array`
PageFrontEdit::inlineEditFields	`array`
PageFrontEdit::inlineLimitPage	`bool` `int`	Limit editor to current page only

Additional methods and properties

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

API reference based on ProcessWire core version 3.0.251