PageAccess class

Provides implementation for Page access functions.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon.

Name	Return	Summary
PageAccess::getAccessParent() PageAccess::getAccessParent(Page $page) PageAccess::getAccessParent(Page $page, string $type = 'view', int $level = 0)	`Page` `NullPage`	Returns the parent page that has the template from which we get our role/access settings from
PageAccess::getAccessRoles() PageAccess::getAccessRoles(Page $page) PageAccess::getAccessRoles(Page $page, string $type = 'view')	`PageArray`	Return the PageArray of roles that have access to this page
PageAccess::getAccessTemplate() PageAccess::getAccessTemplate(Page $page) PageAccess::getAccessTemplate(Page $page, string $type = 'view')	`Template` `null`	Returns the template from which we get our role/access settings from
PageAccess::getType() PageAccess::getType($name) PageAccess::getType($name)	`string`	Normalize a permission name type
PageAccess::getWire() PageAccess::getWire() PageAccess::getWire()	`ProcessWire`	Get the ProcessWire instance
PageAccess::hasAccessRole() PageAccess::hasAccessRole(Page $page, $role) PageAccess::hasAccessRole(Page $page, $role, string $type = 'view')	`bool`	Returns whether this page has the given access role
PageAccess::setWire() PageAccess::setWire(ProcessWire $wire) PageAccess::setWire(ProcessWire $wire)	None	Set the ProcessWire instance
PageAccess::wire() PageAccess::wire() PageAccess::wire($name = '', $value = null, bool $lock = false)	`mixed` `Fuel`	Get or inject a ProcessWire API variable or fuel a new object instance

API reference based on ProcessWire core version 3.0.255