$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 #522
    In the 522nd issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new module called File Mover, and more. Read on!
    Weekly.pw / 11 May 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

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits