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

Show “WireData”             Show Arguments        

Retrieval

NameReturnSummary 
WireData::and()
WireArrayTake the current item and append the given item(s), returning a new WireArray
WireData::data()
array, WireData or nullGet or set a low-level data value
WireData::get($key)
mixed or nullRetrieve the value for a previously set property, or retrieve an API variable
WireData::getArray()
arrayReturns the full array of properties set to this object
WireData::getDot(string $key)
null or mixedGet a property via dot syntax: field.subfield.subfield
WireData::getIterator()
ArrayObjectEnables the object data properties to be iterable as an array
WireData::has(string $key)
boolDoes this object have the given property?

Manipulation

NameReturnSummary 
WireData::data()
array, WireData or nullGet or set a low-level data value
WireData::remove(string $key)
$thisRemove a previously set property
WireData::set(string $key, mixed $value)
$thisSet a value to this object’s data
WireData::setArray(array $data)
$thisSet an array of key=value pairs
WireData::setQuietly(string $key, mixed $value)
$thisSame 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:

API reference based on ProcessWire core version 3.0.60