Retrieving Mautic settings in Twig
Mautic allows you to access configuration settings directly in Twig templates using the configGetParameter
function. This feature is particularly useful for creating display conditions or showing existing data in your templates.
Basic usage
To retrieve a setting, use the configGetParameter
function with the parameter name as its argument:
{{ configGetParameter('parameter_name') }}
Display conditions
Use configGetParameter
in conditional statements to control the display of content based on configuration settings:
{% if configGetParameter('ip_lookup_auth') %}
<!-- Content to display if ip_lookup_auth is enabled or has a filled value -->
{% endif %}
Displaying configuration values
To directly display a configuration value in your template, use the following syntax:
{{ configGetParameter('parameter_name') }}
It’s also possible to define the default value as a second parameter:
{{ configGetParameter('parameter_name', 'default value') }}
For example, to display the API OAuth2 access token lifetime:
API OAuth2 Access Token Lifetime: {{ configGetParameter('api_oauth2_access_token_lifetime') }}
Finding available parameters
The /config/local.php
file contains available configuration parameters, once you save the global configuration form for the first time. This file contains the complete list of settings that are accessible using configGetParameter
.
Identifying parameter names
To find the correct parameter name for a specific setting:
Inspect the HTML of the setting field in the Mautic interface.
Look for the
name
attribute of the input field.The parameter name is the last part of the
name
attribute value.
For example, if you see:
<input name="config[apiconfig][api_oauth2_access_token_lifetime]" ...>
The corresponding parameter name would be api_oauth2_access_token_lifetime
.
Additional information
Be cautious when displaying sensitive configuration data in templates.
Always consider providing default values when using configuration parameters to handle cases where the setting aren’t defined.
Using the configGetParameter
function in Twig, you can create new interactive experiences in Mautic.