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

Please note this method is and thus not intended to be called directly.

Internal usage

// basic internal usage
$mixed = wire();

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