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

Twitter updates

  • ProcessWire 3.0.187: This week we have some very useful new additions to both the core Repeater Fieldtype and the ProFields Repeater Matrix Fieldtype. This post covers all the details along with a couple of brief demonstration videos— More
    22 October 2021
  • ProcessWire 3.0.185 (dev) core updates, plus new Session Allow module— More
    17 September 2021
  • Three new ProcessWire Textformatter modules: Find/Replace, Markdown in Markup, and Emoji— More
    3 September 2021

Latest news

  • ProcessWire Weekly #389
    The 389th issue of ProcessWire Weekly we'll check out the latest core updates, introduce the Session Viewer module, and more. Read on!
    Weekly.pw / 23 October 2021
  • New Repeater and Repeater Matrix features
    This week we have some very useful new additions to both the core Repeater Fieldtype and the ProFields Repeater Matrix Fieldtype. This post covers all the details along with a couple of brief demonstration videos. 
    Blog / 22 October 2021
  • 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