$config->jsConfig() method

Set or retrieve a config value exclusive to Javascript (ProcessWire.config)

Values are set to the Javascript variable ProcessWire.config[key].

Unlike $config->js(), values get or set are exclusive to JS config only.

Values set with this method can be retrieved via $config->js() or $config->jsConfig(), but they cannot be retrieved from $config->['key'] or $config->get('key').

If setting a new property for the JS config it is recommended that you use this method rather than $config->js() in ProcessWire 3.0.173+. If backwards compatibility is needed then you should still use $config->js().

  1. Specify a $key and $value to set a JS config value.

  2. Specify only a $key and omit the $value in order to retrieve an existing set value.

  3. Specify no params to retrieve in array of all existing set values.

Available since version 3.0.173.

Examples

// Set a property from PHP
$config->jsConfig('mySettings', [
  'foo' => 'bar',
  'bar' => 123,
]);

// Get a property (from PHP)
$mySettings = $config->jsConfig('mySettings');
// Get a property (from Javascript):
var mySettings = ProcessWire.config.mySettings;
console.log(mySettings.foo);
console.log(mySettings.bar);

Usage

// basic usage
$mixed = $config->jsConfig();

// usage with all arguments
$mixed = $config->jsConfig(string $key = null, $value = null);

Arguments

NameType(s)Description
key (optional)string

Name of property to get or set or omit to return all data

value (optional)mixed, null

Specify value to set or omit (null) to get

Return value

mixed null array self

Returns null if $key not found, value when getting, self when setting, or array when getting all


$config methods and properties

API reference based on ProcessWire core version 3.0.185

Twitter updates

  • ProcessWire 3.0.192 (dev branch) contains 11 issue fixes and 5 pull requests, over 20 commits— More
    7 January 2022
  • ProcessWire 3.0.191 core updates: updates to the installer and the profile exporter module— More
    24 December 2021
  • This week ProcessWire went on a diet, trimming the core size from 15.5 MB down to 7.5 MB by moving optional site profiles into their own GitHub repos— More
    17 December 2021

Latest news

  • ProcessWire Weekly #401
    In the 401st issue of ProcessWire Weekly we'll cover the latest core updates, check out a brand new module called Lister Native Date Format, and more. Read on!
    Weekly.pw / 15 January 2022
  • ProcessWire 3.0.190 core updates
    ProcessWire 3.0.190 has 15 commits relative to 3.0.189 and contains a mixture of issue resolutions and feature additions. This post covers them all, in addition to updates for the PageAutosave and ProFields Table modules.
    Blog / 3 December 2021
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer