$permissions→getOptionalPermissions()
Get an associative array of all optional permissions
Returned permissions are an associative array in the format ['name' => 'label']
.
Usage
// basic usage
$array = $permissions->getOptionalPermissions();
// usage with all arguments
$array = $permissions->getOptionalPermissions(bool $omitInstalled = true);
Arguments
Name | Type(s) | Description |
---|---|---|
$omitInstalled (optional) | bool | Specify false to include all optional permissions, whether already installed or not. |
Return value
array
Hooking $permissions→getOptionalPermissions(…)
You can add your own hook events that are executed either before or after the $permissions
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 $permissions
method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('Permissions::getOptionalPermissions', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$permissions = $event->object;
// Get values of arguments sent to hook (and optionally modify them)
$omitInstalled = $event->arguments(0);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $omitInstalled);
});
Hooking after
The 'after' hooks are called immediately after each $permissions
method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.
$this->addHookAfter('Permissions::getOptionalPermissions', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$permissions = $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)
$omitInstalled = $event->arguments(0);
/* Your code here, perhaps modifying the return value */
// Populate back return value, if you have modified it
$event->return = $return;
});
$permissions methods and properties
API reference based on ProcessWire core version 3.0.251