{module_favorites}

Description

Displays the list of favorites items for the customer that's logged in (must be logged in to secure zone). There is a limit of 500 items per page before pagination is applied.

Syntax

{module_favorites render="item|collection" collection="my_custom_collection_name" template="/folder/template.tpl" filter="item(individual)|all" itemType="7" itemId=""}

Note: When using named parameters always wrap the individual parameters in double quotes. Also, do note that modules using named parameters do not work for campaigns just yet.

Parameters

  • render - possible values are item or collection (the default is item). The render parameter indicates whether the template content is used to render a collection or to render a single item. Take a look at the render parameter's article for more details on how to use it
  • filter - filtering criteria for display and can be one of the following:
    • item - individual item
    • all - all items
  • itemType -
    • 7 - news items
    • 48 - event items
    • 9 - FAQ items
    • 6 - media downloads
    • 27 - products
    • 35 - webapps
  • itemID - if you choose itemType 35 (a webapp) you can specify the webapp's ID. In this case only the favorite webapp items in that particular webapp will be displayed.
  • collection - use this if you need to access the module's Liquid output tags
  • template - optional, for this module this can either represent the path of the custom template you want to use, or use a blank value (template="") if you need to suppress the original output and use Liquid output tags instead

Examples

  • {module_favorites< itemType="35" itemID="24325"} - displays the webapp items contained by the webapp with the ID 24325 that have been added as "favorites" by the currently logged in user. The items are displayed using their "List" layout.
  • {module_favorites filter="all"} - displays all the items (regardless of the item type) added marked as favorite by the logged in user. The items are displayed using their "List" layout.

Syntax

{module_favorites,filter,itemType,itemId}

Parameters

  • filter - filtering criteria for display and can be one of the following:
    • i - individual item
    • a - all items
  • itemType -
    • 7 - news items
    • 48 - event items
    • 9 - FAQ items
    • 6 - media downloads
    • 27 - products
    • 35 - webapps
  • itemID - if you choose itemType 35 (a webapp) you can specify the webapp's ID. In this case only the favorite webapp items in that particular webapp will be displayed.

Examples

  • {module_favorites,35,24325} - displays the webapp items contained by the webapp with the ID 24325that have been added as "favorites" by the currently logged in user. The items are displayed using their "List" layout.
  • {module_favorites,a} - displays all the items (regardless of the item type) added marked as favorite by the logged in user. The items are displayed using their "List" layout.