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

Twitter updates

  • Adding custom actions to ProcessWire image fields in the admin, part of this week’s dev branch additions: More
    27 January 2023
  • ProcessWire 3.0.210 new main/master version released— More
    6 January 2023
  • ProcessWire 3.0.209: Core updates and an interesting AI that knows ProcessWire– More
    30 December 2022

Latest news

  • ProcessWire Weekly #455
    In the 455th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new third party module called JkPublishPages, and more. Read on!
    Weekly.pw / 28 January 2023
  • ProcessWire 3.0.210 new main/master version
    140 commits, 55 resolved issues, dozens of new features, eight contributors, and five new pull requests make yet another great new version of ProcessWire.
    Blog / 6 January 2023
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer