$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 onfig->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.184

Twitter updates

  • ProcessWire 3.0.185 (dev) core updates, plus new Session Allow module— More
    17 September 2021
  • Three new ProcessWire Textformatter modules: Find/Replace, Markdown in Markup, and Emoji— More
    3 September 2021
  • This week we have a new master version released after a year in the making. With nearly 40 pull requests, hundreds of new additions and more than 100 issue reports resolved, this new version has a ton of great new stuff— More
    27 August 2021

Latest news

  • ProcessWire Weekly #384
    In the 384th issue of ProcessWire Weekly we'll cover the latest core updates, introduce a new module called Session Allow, and highlight a new site of the week. Read on!
    Weekly.pw / 18 September 2021
  • ProcessWire 3.0.184 new master/main version
    This week we have a new master/main version released after a full year in the making. As you might imagine, this new version has a ton of great new stuff and we’ll try to cover much of it here.
    Blog / 27 August 2021
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani