$wireset()

Set a new API variable

Alias of $this->wire(), but for setting only, for syntactic convenience. i.e. $this->wire()->set($key, $value);

Usage

// basic usage
$wire->set(string $key, $value);

// usage with all arguments
$wire->set(string $key, $value, bool $lock = false);

Arguments

NameType(s)Description
$keystring

API variable name to set

$valueWire mixed

Value of API variable

$lock (optional)bool

Whether to lock the value from being overwritten

Return value

$this

Object instance it was called from (method supports fluent interface).


$wire methods and properties

API reference based on ProcessWire core version 3.0.251