$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.248

Latest news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH