{config_load} is used for loading config #variables# from a configuration file into the template.
Attribute Name | Type | Required | Default | Description |
---|---|---|---|---|
file | string | Yes | n/a | The name of the config file to include |
section | string | No | n/a | The name of the section to load |
scope | string | no | local | How the scope of the loaded variables are treated, which must be one of local, parent or global. local means variables are loaded into the local template context. parent means variables are loaded into both the local context and the parent template that called it. global means variables are available to all templates. |
global | boolean | No | No | Whether or not variables are visible to the parent template, same as scope=parent. NOTE: This attribute is deprecated by the scope attribute, but still supported. If scope is supplied, this value is ignored. |
Config Files may also contain sections. You can load variables from within a section with the added attribute section. Note that global config variables are always loaded along with section variables, and same-named section variables overwrite the globals.
Note: Config file sections and the built-in template function called {section} have nothing to do with each other, they just happen to share a common naming convention.
Example 7-4. function {config_load} with section
|
See $config_overwrite to create arrays of config file variables.
See also the config files page, config variables page, $config_dir, get_config_vars() and config_load().