$user→hasPagePermission()
Does this user have named permission for the given Page?
This is a basic permission check and it is recommended that you use those from the PagePermissions module instead. You use the PagePermissions module by calling the editable(), addable(), etc., functions on a page object. The PagePermissions does use this function for some of it's checking.
This protected method is for hooks to monitor and it is likely not intended to be called directly.
Internal usage
// basic internal usage
$bool = $user->hasPagePermission($name);
// internal usage with all arguments
$bool = $user->hasPagePermission($name, $page = null);Arguments
Hooking $user→hasPagePermission(…)
You can add your own hook events that are executed either before or after the $user method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.
Hooking before
The 'before' hooks are called immediately before each $user method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('User::hasPagePermission', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$user = $event->object;
// Get values of arguments sent to hook (and optionally modify them)
$name = $event->arguments(0);
$page = $event->arguments(1);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $name);
$event->arguments(1, $page);
});Hooking after
The 'after' hooks are called immediately after each $user method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.
$this->addHookAfter('User::hasPagePermission', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$user = $event->object;
// An 'after' hook can retrieve and/or modify the return value
$return = $event->return;
// Get values of arguments sent to hook (if needed)
$name = $event->arguments(0);
$page = $event->arguments(1);
/* Your code here, perhaps modifying the return value */
// Populate back return value, if you have modified it
$event->return = $return;
});API reference based on ProcessWire core version 3.0.251