PagesAccess::updatePage()
Save to pages_access table to indicate what template each page is getting its access from
This should be called when a page has been saved and its parent or template has changed. Or, when a new page is added.
If there is no entry in this table, then the page is getting its access from its existing template.
This is used by PageFinder to determine what pages to include in a find() operation based on user access.
Usage
$pagesAccess->updatePage(Page $page);Arguments
| Name | Type(s) | Description |
|---|---|---|
$page | Page |
Hooking PagesAccess::updatePage(…)
You can add your own hook events that are executed either before or after the Pages 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 Pages method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('PagesAccess::updatePage', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$PagesAccess = $event->object;
// Get values of arguments sent to hook (and optionally modify them)
$page = $event->arguments(0);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $page);
}); Hooking after
The 'after' hooks are called immediately after each Pages method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.
$this->addHookAfter('PagesAccess::updatePage', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$PagesAccess = $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)
$page = $event->arguments(0);
/* Your code here, perhaps modifying the return value */
// Populate back return value, if you have modified it
$event->return = $return;
}); PagesAccess methods and properties
API reference based on ProcessWire core version 3.0.257