Skip to main content

Module

The module loop retrieve module informations
{loop type="module" name="the-loop-name" [argument="value"], [...]}

Arguments

ArgumentDescriptionDefaultExample
activeA boolean value.active="no"
areaA single or a list of area ids. Only modules assigned to this area will be returned.area="5", profile="3,2,17"
codeModule codecode="Foo"
excludeA single or a list of module ids to exclude.exclude="2", exclude="1,4,7"
idA single or a list of module ids.id="2", id="1,4,7"
module_typeModule type (classic, payment or delivery)
Expected values :
1 : classic module
2 : delivery module
3 : payment module
module_type="1"
orderA list of values see sorting possible valuesmanualorder="alpha_reverse"
profileA single or a list of profile ids.profile="2", profile="1,4,7"

Plus the global arguments

Outputs

VariableValue
$ACTIVEcheck if the module is activated or not
$CHAPOthe module chapo
$CLASSThe full namespace for the module class
$CODEThe module code
$DESCRIPTIONthe module description
$IDthe module ID
$IS_TRANSLATEDreturn true if the module is translated
$LOCALEThe locale used for this research
$POSITIONthe position of this module
$POSTSCRIPTUMthe module postscriptum
$TITLEthe module title
$TYPEThe module type

Plus the global outputs

Order possible values

Arguments

Ascending valueDescending valueSorted fields
codecode_reversecode
enabledenabled_reverseenabled status
idid_reverseId
manualmanual_reverseposition
titletitle_reversetitle
typetype_reversetype