Smarty Manual
Prev | Chapter 7. Built-in Functions | Next

# config_load

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.

This function is used for loading in variables from a configuration file into the template. See Config Files for more info.

Example 7-2. function config_load
    {config_load file="colors.conf"}

    <html>
    <title>{#pageTitle#}</title>
    <body bgcolor="{#bodyBgColor#}">
    <table border="{#tableBorderSize#}" bgcolor="{#tableBgColor#}">
       <tr bgcolor="{#rowBgColor#}">
          <td>First</td>
          <td>Last</td>
          <td>Address</td>
       </tr>
    </table>
    </body>
    </html>

Config files may also contain sections. You can load variables from within a section with the added attribute section.

> 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-3. function config_load with section
    {config_load file="colors.conf" section="Customer"}

    <html>
    <title>{#pageTitle#}</title>
    <body bgcolor="{#bodyBgColor#}">
    <table border="{#tableBorderSize#}" bgcolor="{#tableBgColor#}">
       <tr bgcolor="{#rowBgColor#}">
          <td>First</td>
          <td>Last</td>
          <td>Address</td>
       </tr>
    </table>
    </body>
    </html>

Prev | Home | Next
Built-in Functions | Up | foreach,foreachelse