Process::setViewVars() method

Set a variable that will be passed to the output view.

You can also do this by having your execute() method(s) return an associative array of variables to send to the view file.

Usage

// basic usage
$process->setViewVars($key);

// usage with all arguments
$process->setViewVars($key, $value = null);

Arguments

NameType(s)Description
keystring, array

Property to set, or array of [property => value] to set (leaving 2nd argument as null)

value (optional)mixed, null

Value to set

Return value

$this

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

Exceptions

Method can throw exceptions on error:

  • WireException - if given an invalid type for $key


Process methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #554
    In the 554th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 21 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer