Return an API variable, or return current ProcessWire instance if given no arguments

  • Call wire() with no arguments returns the current ProcessWire instance.
  • Call wire('var') to return the API variable represented by 'var', or null if not present.
  • Call wire('all') or wire('*') to return an iterable object of all API variables.
  • Call wire($object) to attach $object to the current instance ($object must be Wire-derived object).

Usage

// basic usage
$mixed = wire();

// usage with all arguments
$mixed = wire(string $name = 'wire');

Arguments

NameType(s)Description
name (optional)string

If omitted, returns current ProcessWire instance.

Return value

mixed

Requested API variable or null if it does not exist


Functions methods and properties

API reference based on ProcessWire core version 3.0.163

Twitter updates

  • This week we’re proud to announce the newest ProcessWire master version 3.0.164. Relative to the previous master (3.0.148) this version adds a ton of new & useful features and fixes more than 85 issues, with more than 225 commits over 7 months— More
    7 August 2020
  • ProcessWire 3.0.163 resolves more than a dozen issue reports and adds new hooks and configurable module install options, among numerous other updates. In addition, a major update to ProCache (v4.0) has been released— More
    24 July 2020
  • Weekly update for 17 July 2020 and a look at new features coming in next week's version of ProCache— More
    17 July 2020

Latest news

  • ProcessWire Weekly #325
    In the 325th issue of ProcessWire Weekly we're going to cover a new master version of ProcessWire, introduce the Textformatter Audio Embed module, and more. Read on!
    Weekly.pw / 1 August 2020
  • ProcessWire 3.0.164 new master version
    This week we’re proud to announce the newest ProcessWire master version 3.0.164. Relative to the previous master version (3.0.148) this version adds a ton of new and useful features and fixes more than 85 issues, with more than 225 commits over a period of 7 months.
    Blog / 7 August 2020
  • 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