$fuel->set() method

@param string $key API variable name to set - should be valid PHP variable name.

Usage

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

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

Arguments

NameType(s)Description
keystring

API variable name to set - should be valid PHP variable name.

valueobject, mixed

Value for the API variable.

lock (optional)bool

Whether to prevent this API variable from being overwritten in the future.

Return value

$this

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

Exceptions

Method can throw exceptions on error:

  • WireException - When you try to set a previously locked API variable, a WireException will be thrown.


$fuel methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #559
    The 559th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 25 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK