$wire->set() method

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.236

Latest news

  • ProcessWire Weekly #518
    The 518th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 13 April 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.