Store or retrieve an extra data value in this WireArray
The data() function is exactly the same thing that it is in jQuery: http://api.jquery.com/data/.
Example
// set a data value named 'foo' to value 'bar'
$a->data('foo', 'bar');
// retrieve the previously set data value
$bar = $a->data('foo');
// get all previously set data
$all = $a->data(); Usage
// basic usage
$items = $wireArray->data();
// usage with all arguments
$items = $wireArray->data($key = null, $value = null);Arguments
| Name | Type(s) | Description |
|---|---|---|
key (optional) | string, null, array, bool | Name of data property you want to get or set, or:
|
value (optional) | mixed, null, bool | Value of data property you want to set. Omit when getting properties.
|
Return value
WireArray mixed array nullReturns one of the following, depending on specified arguments:
mixedwhen getting a single property: whatever you set is what you will get back.nullif the property you are trying to get does not exist in the data.$thisreference to this WireArray if you were setting a value.arrayof all data if you specified no arguments or requested multiple keys.
See Also
WireArray methods and properties
API reference based on ProcessWire core version 3.0.214