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

Twitter updates

  • Introduction to an invoice application profile being built in ProcessWire: More
    30 September 2022
  • Stumbling upon a really nice ProcessWire-powered website, plus core updates including API improvements for ProcessWire forms— More
    9 September 2022
  • Useful new dot-and-bracket syntax options added for page.get() method— More
    2 September 2022

Latest news

  • ProcessWire Weekly #438
    In the 348th issue of ProcessWire Weekly we're going to cover the latest weekly update from Ryan, take a closer look at a couple of new third party modules, and more. Read on!
    Weekly.pw / 1 October 2022
  • Multi-language field translation export/import
    In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire.
    Blog / 5 August 2022
  • Subscribe to weekly ProcessWire news

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