blog documentation FAQ followers forum marketplace services youtube

{jrProfile_menu}

The Jamroom Network » Documentation » Module Developer Guide » {jrProfile_menu}

Table of Contents:


Overview
Function jrProfile_menu
Targets Parameter

  • Overview

    The {jrProfile_menu} template function is used to put the tab buttons for each module onto the profile page.

    When a profile page is opened, you will see a list of the modules that that profile has access to and can view what they have uploaded by clicking on the button link.

    Its {jrProfile_menu} that creates those links. It has some options to allow the skin designers to adjust what is output.

  • jrProfile_menu

    Function
    jrProfile_menu
    parameter
    type
    default
    required
    description
    template
    text
    N/A
    on
    The name of the template used for formatting of the returned data.
    profile_quota_id
    int
    N/A
    on
    The profile_id of the profile that is being looked at.
    profile_url
    string
    N/A
    on
    The url of the profile. usually passed in via profile_url=$profile_url
    exclude_modules
    string
    -
    off
    The names of modules to exclude from the item list. eg: exclude_modules="jrAction,jrGallery"
    modules
    string
    -
    off
    The names of modules to include in item list. eg: exclude_modules="jrAudio,jrGallery"
    targets
    string
    -
    off
    override the target page for a module. eg: targets="jrAudio:audio/albums"
    order
    string
    -
    off
    the order of the menus. eg: order="jrFAQ,jrGallery,jrBlog" (unlisted active modules will be added to the end of the list)
    always_show
    string
    -
    off
    By default a menu button will NOT show if there are no entries in the DS for that specific module/profile_id. We can override that behavior by setting which modules should always show.
    require_login
    string
    -
    off
    See if we are requiring a login

  • Targets Parameter

    The 'targets' parameter allows the designer to override the "target" - i.e. the page that is going to be opened when clicked on. By default it is the module's URL - i.e. "audio", but we could do something like:
    targets="jrAudio:audio/albums"

    And when the user clicks on "audio" in the profile menu, instead of going to: site.com/profile/audio they would instead go to: site.com/profile/audio/albums

Tags