WireData class

WireData is the base data-storage class used by many ProcessWire object types and most modules.

WireData is very much like its parent Wire class with the fundamental difference being that it is designed for runtime data storage. It provides this primarily through the built-in get() and set() methods for getting and setting named properties to WireData objects. The most common example of a WireData object is Page, the type used for all pages in ProcessWire.

Properties set to a WireData object can also be set or accessed directly, like $item->property or using array access like $item[$property]. If you foreach() a WireData object, the default behavior is to iterate all of the properties/values present within it.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the WireData class also inherits all the methods and properties of: Wire.

Retrieval
Manipulation

Retrieval

Name	Return	Summary
WireData::and() WireData::and() WireData::and($items = null)	`WireArray`	Take the current item and append the given item(s), returning a new WireArray
WireData::data() WireData::data() WireData::data($key = null, mixed $value = null)	`array` `WireData` `null`	Get or set a low-level data value
WireData::get() WireData::get($key) WireData::get($key)	`mixed` `null`	Retrieve the value for a previously set property, or retrieve an API variable
WireData::getArray() WireData::getArray() WireData::getArray()	`array`	Returns the full array of properties set to this object
WireData::getDot() WireData::getDot(string $key) WireData::getDot(string $key)	`null` `mixed`	Get a property via dot syntax: field.subfield.subfield
WireData::getIterator() WireData::getIterator() WireData::getIterator()	`ArrayObject`	Enables the object data properties to be iterable as an array
WireData::has() WireData::has(string $key) WireData::has(string $key)	`bool`	Does this object have the given property?

Manipulation

Name	Return	Summary
WireData::data() WireData::data() WireData::data($key = null, mixed $value = null)	`array` `WireData` `null`	Get or set a low-level data value
WireData::remove() WireData::remove(string $key) WireData::remove(string $key)	`$this`	Remove a previously set property
WireData::set() WireData::set(string $key, mixed $value) WireData::set(string $key, mixed $value)	`$this`	Set a value to this object’s data
WireData::setArray() WireData::setArray(array $data) WireData::setArray(array $data)	`$this`	Set an array of key=value pairs
WireData::setQuietly() WireData::setQuietly(string $key, mixed $value) WireData::setQuietly(string $key, mixed $value)	`$this`	Same as set() but without change tracking

Additional methods and properties

In addition to the methods and properties above, WireData also inherits the methods and properties of these classes:

Wire

API reference based on ProcessWire core version 3.0.252