WireData is the base data-storage class used by many ProcessWire object types and most modules.
WireWire 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 WirePage, the type used for all pages in ProcessWire.
Properties set to a Wire$item->property or using array access like $item[$property]. If you foreach() a Wire
Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the Wire class also inherits all the methods and properties of: Wire.
Retrieval
| Name | Return | Summary | |
|---|---|---|---|
Wire Wire Wire | WireArray | Take the current item and append the given item(s), returning a new WireArray | |
Wire Wire Wire | array Wire null | Get or set a low-level data value | |
Wire Wire Wire | mixed null | Retrieve the value for a previously set property, or retrieve an API variable | |
Wire Wire Wire | array | Returns the full array of properties set to this object | |
Wire Wire Wire | null mixed | Get a property via dot syntax: field.subfield.subfield | |
Wire Wire Wire | ArrayObject | Enables the object data properties to be iterable as an array | |
Wire Wire Wire | bool | Does this object have the given property? |
Manipulation
| Name | Return | Summary | |
|---|---|---|---|
Wire Wire Wire | array Wire null | Get or set a low-level data value | |
Wire Wire Wire | $this | Remove a previously set property | |
Wire Wire Wire | $this | Set a value to this object’s data | |
Wire Wire Wire | $this | Set an array of key=value pairs | |
Wire Wire Wire | $this | Same as set() but without change tracking |
Additional methods and properties
In addition to the methods and properties above, Wire
API reference based on ProcessWire core version 3.0.244