$process

Enables viewing or Processes, one of the core components in connecting ProcessWire to HTTP.

For more details about how Process modules work, please see: wire/core/Process.php

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.

Show $var?     Show args?       Only hookable?    

Common

NameReturnSummary 
$process->execute()
string

Retrieve a page, check access, and render

$process->executeExternal()
string

Method executed when externally bootstrapped

$process->failed(\Throwable $e)
None

Hook called when the pageview failed to finish due to an Exception or Error.

$process->finished()
None

Hook called with the pageview has been finished and output has been sent. Note this is called in /index.php.

$process->getPage()
NullPage Page

Get requested page

 
$process->getResponseType()
int

Return the response type for this request, as one of the responseType constants

 
$process->pathHooks($path, $out)
string bool array Page
$process->setDelayRedirects(bool $delayRedirects)
None

Set whether any redirects should be performed after the API ready() call

 
$process->setResponseType(int $responseType)
None

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.

NameReturnSummary 
$process->userNotAllowed(User $user, $page, PagesRequest $request)
None

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.252