Represents an instance of ProcessWire connected with a set of API variables.

This class boots a ProcessWire instance. The current ProcessWire instance is represented by the $wire API variable.

// To create a new ProcessWire instance
$wire = new ProcessWire('/server/path/', 'https://hostname/url/');

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the ProcessWire class also inherits all the methods and properties of: Wire.

Common / Constants / For hooks / Instances

Show “ProcessWire”             Show Arguments        

Common

NameReturnSummary 
ProcessWire::__construct()
(nothing)Create a new ProcessWire instance
ProcessWire::buildConfig(string $rootPath)
ConfigStatic method to build a Config object for booting ProcessWire
ProcessWire::set(string $key, $value)
$thisSet a new API variable
ProcessWire::setStatus($status)
(nothing)Set the system status to one of the ProcessWire::status* constants

Constants

NameReturnSummary 
ProcessWire::htaccessVersion const300Minimum required .htaccess file version
ProcessWire::indexVersion const300Minimum required index.php version, represented by the PROCESSWIRE define
ProcessWire::statusBoot const0Status when system is booting
ProcessWire::statusFailed const1024Status when the request failed due to an Exception or 404
ProcessWire::statusFinished const16Status when the request has been fully delivered
ProcessWire::statusInit const2Status when system and modules are initializing
ProcessWire::statusReady const4Systus when system, $page and API variables are ready
ProcessWire::statusRender const8Status when the current $page’s template file is being rendered
ProcessWire::versionMajor const3Major version number
ProcessWire::versionMinor const0Minor version number
ProcessWire::versionRevision const62Reversion revision number
ProcessWire::versionSuffix const(nothing)Version suffix string (when applicable)

For hooks

These methods are only useful for hooking and should not be called directly.

NameReturnSummary 
ProcessWire::finished()
(nothing)Hookable ready for anyone that wants to hook when the request is finished
ProcessWire::init()
(nothing)Hookable init for anyone that wants to hook immediately before any autoload modules initialized or after all modules initialized
ProcessWire::ready()
(nothing)Hookable ready for anyone that wants to hook immediately before any autoload modules ready or after all modules ready

Additional methods and properties

In addition to the methods and properties above, ProcessWire also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.62