All page views are routed through this Process
Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the ProcessPageView class also inherits all the methods and properties of: Process, WireData and Wire.
Common
| Name | Return | Summary | |
|---|---|---|---|
$process->execute() $process->execute() $process->execute(bool $internal = true) | string | Retrieve a page, check access, and render | |
$process->executeExternal() $process->executeExternal() $process->executeExternal() | string | Method executed when externally bootstrapped | |
$process->failed() $process->failed(\Throwable $e) $process->failed(\Throwable $e, string $reason = '', $page = null, string $url = '') | (nothing) | Hook called when the pageview failed to finish due to an Exception or Error. | |
$process->finished() $process->finished() $process->finished(array $data = []) | (nothing) | Hook called with the pageview has been finished and output has been sent. Note this is called in /index.php. | |
$process->getPage() $process->getPage() $process->getPage() | NullPage Page | Get requested page | |
$process->getResponseType() $process->getResponseType() $process->getResponseType() | int | Return the response type for this request, as one of the responseType constants | |
$process->pageNotFound() $process->pageNotFound($page, $url) $process->pageNotFound($page, $url, $triggerReady = false, $reason = '', \Exception $e = null) | string | ||
$process->pathHooks() $process->pathHooks($path, $out) $process->pathHooks($path, $out) | string bool array Page | ||
$process->setDelayRedirects() $process->setDelayRedirects(bool $delayRedirects) $process->setDelayRedirects(bool $delayRedirects) | (nothing) | Set whether any redirects should be performed after the API ready() call | |
$process->setResponseType() $process->setResponseType(int $responseType) $process->setResponseType(int $responseType) | (nothing) | Set the response type for this request, see responseType constants in this class |
For hooks
These methods are only useful for hooking and should not be called directly.
| Name | Return | Summary | |
|---|---|---|---|
$process->userNotAllowed() $process->userNotAllowed(User $user, $page, PagesRequest $request) $process->userNotAllowed(User $user, $page, PagesRequest $request) | (nothing) | Called when a 401 unauthorized or 403 forbidden request |
Additional methods and properties
In addition to the methods and properties above, ProcessPageView also inherits the methods and properties of these classes:
API reference based on ProcessWire core version 3.0.244