Config Loop

Config loop, to access configuration variables

{loop type="config" name="the-loop-name" [argument="value"], [...]}

Important informations :

* : argument is required
** : at least one of ** marked argument is required

Global arguments

Argument Description
backend_context

Determine if loop is use in backend context.

default : false

example : backend_context="on"

force_return

force return result for i18n tables even if there is no record

default : false

example : force_return="on"

limit

The maximum number of results to display.

example : limit="10"

name *

The loop name. This name must be unique and is used to reference this loop further in the page (see ifloop, elseloop or pageloop)

offset

The first product to display offset. Will not be used if `page` argument is set.

default : 0

example : offset="1"

page

The page to display.

example : page="2"

Loop arguments

Argument Description
exclude

A single or a list of config ids.

example : exclude="2", exclude="1,4,7"

hidden

A boolean value.

example : hidden="no"

id

A single of config id.

example : id="2"

order

A list of values

Expected values :
  • id : order by id
  • id_reverse : order by id DESC
  • name : order by variable name
  • name_reverse : reverse order by variable name
  • title : order by title
  • title_reverse : order by title
  • value : order by variable value
  • value_reverse : reverse order by variable value

default : manual

example : order="id_reverse"

secured

A boolean value.

example : secured="no"

variable

Name of a variable config

example : variable="rewriting_enable"

Global outputs

Variable Description
$LOOP_COUNT the current results index, starting from 1
$LOOP_TOTAL the total number of results returned by the loop
$CREATE_DATE The creation date of this Config
$UPDATE_DATE The last modification date of this Config

Loop outputs

Variable Description
$CHAPO The config variable chapo
$DESCRIPTION The config variable description
$HIDDEN check if the config variable is hidden
$ID the config variable id
$IS_TRANSLATED check if the config is translated
$LOCALE The locale used for this research
$NAME the config variable name
$POSTSCRIPTUM The config variable postscriptum
$SECURED check if the config variable is secured
$TITLE The config variable title
$VALUE the config variable value