Wire is the base class for most ProcessWire classes and modules.

Wire derived classes have a $this->wire() method that provides access to ProcessWire’s API variables. API variables can also be accessed as local properties in most cases. Wire also provides basic methods for tracking changes and managing runtime notices specific to the instance.

Wire derived classes can specify which methods are “hookable” by precending the method name with 3 underscores like this: ___myMethod(). Other classes can then hook either before or after that method, modifying arguments or return values. Several other hook methods are also provided for Wire derived classes that are hooking into others.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon.

Show class?             Show args?        

Common

NameReturnSummary 
Wire::wire()
mixedGet an API variable, create an API variable, or inject dependencies. 

Notices

NameReturnSummary 
Wire::error($text)
$thisRecord an non-fatal error message in the system-wide notices. 
Wire::errors()
Notices array stringReturn or manage errors recorded by just this object or all Wire objects 
Wire::log()
WireLogLog a message for this class
Wire::message($text)
$thisRecord an informational or “success” message in the system-wide notices. 
Wire::messages()
Notices array stringReturn or manage messages recorded by just this object or all Wire objects 
Wire::warning($text)
$thisRecord a warning error message in the system-wide notices. 
Wire::warnings()
Notices array stringReturn or manage warnings recorded by just this object or all Wire objects 

Identification

NameReturnSummary 
Wire::className()
stringReturn this object’s class name 
Wire::getInstanceNum()
intGet this Wire object’s instance number 

For hooks

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

NameReturnSummary 
Wire::callUnknown(string $method, array $arguments)
null mixedIf method call resulted in no handler, this hookable method is called.
Wire::changed(string $what)
(nothing)Hookable method that is called whenever a property has changed while change tracking is enabled.
Wire::trackException($e)
$thisHookable method called when an Exception occurs

Hooks

Methods for managing hooks for an object instance or class.

NameReturnSummary 
Wire::addHookAfter($method, $toObject)
stringAdd a hook to be executed after the hooked method 
Wire::addHookBefore($method, $toObject)
stringAdd a hook to be executed before the hooked method 
Wire::addHookMethod(string $method, $toObject)
stringAdd a hook accessible as a new public method in a class (or object) 
Wire::addHookProperty($property, $toObject)
stringAdd a hook that will be accessible as a new object property. 
Wire::getHooks()
arrayReturn all hooks associated with this class instance or method (if specified) 
Wire::hasHook(string $name)
boolReturns true if the method or property is hooked, false if it isn’t. 
Wire::removeHook($hookId)
$thisGiven a Hook ID, remove the hook 

Changes

Methods to support tracking and retrieval of changes made to the object.

NameReturnSummary 
Wire::getChanges()
arrayReturn an array of properties that have changed while change tracking was on. 
Wire::isChanged()
boolDoes the object have changes, or has the given property changed? 
Wire::resetTrackChanges()
$thisClears out any tracked changes and turns change tracking ON or OFF 
Wire::setTrackChanges()
$thisTurn change tracking ON or OFF 
Wire::trackChange(string $what)
$thisTrack a change to a property in this object 
Wire::trackChanges()
intReturns true or 1 if change tracking is on, or false or 0 if it is not, or mode bitmask (int) if requested. 
Wire::trackChangesOn const2For setTrackChanges() method flags: track names only (default). 
Wire::trackChangesValues const4For setTrackChanges() method flags: track names and values. 
Wire::untrackChange(string $what)
$thisUntrack a change to a property in this object 

Api helpers

Shortcuts to ProcessWire API variables. Access without any arguments returns the API variable. Some support arguments as shortcuts to methods in the API variable.

NameReturnSummary 
Wire::cache()
WireCache string array PageArray nullAccess the $cache API variable as a function.
Wire::config()
Config mixedAccess the $config API variable as a function.
Wire::database()
WireDatabasePDOAccess the $database API variable as a function.
Wire::datetime()
WireDateTime string intAccess the $datetime API variable as a function.
Wire::fields()
Field Fields nullAccess the $fields API variable as a function.
Wire::files()
WireFileToolsAccess the $files API variable as a function.
Wire::input()
WireInput WireInputData WireInputDataCookie array string int nullAccess the $input API variable as a function.
Wire::inputCookie()
WireInputDataCookie string int array nullAccess the $input->cookie() API variable as a function.
Wire::inputGet()
WireInputData string int array nullAccess the $input->get() API variable as a function.
Wire::inputPost()
WireInputData string int array nullAccess the $input->post() API variable as a function.
Wire::languages()
Languages Language NullPage nullAccess the $languages API variable as a function.
Wire::modules()
Modules Module ConfigurableModule nullAccess the $modules API variable as a function.
Wire::page()
Page MixedAccess the $page API variable as a function.
Wire::pages()
Pages PageArray Page NullPageAccess the $pages API variable as a function.
Wire::permissions()
Permissions Permission PageArray null NullPageAccess the $permissions API variable as a function.
Wire::roles()
Roles Role PageArray null NullPageAccess the $roles API variable as a function.
Wire::sanitizer()
Sanitizer string int array null mixedAccess the $sanitizer API variable as a function.
Wire::session()
Session mixedAccess the $session API variable as a function.
Wire::templates()
Templates Template nullAccess the $templates API variable as a function.
Wire::user()
User mixedAccess the $user API variable as a function.
Wire::users()
Users PageArray User mixedAccess the $users API variable as a function.

API reference based on ProcessWire core version 3.0.236

Newest forum posts

Latest news

  • ProcessWire Weekly #549
    In the 549th issue of ProcessWire Weekly we’re going to check out the latest core updates, highlight one older yet still very relevant third party module, and more. Read on!
    Weekly.pw / 17 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull