Name |
Type |
Required |
Default |
Description |
type |
string |
yes |
n/a |
Jamroom supports comments for a wide variety of items in Jamroom. the "type" parameter tells Jamroom what type of comment(s) you want to show. Valid options are: "artist", "song", "video", "radio", "photo", "event", "vault", "item" and "message". |
template |
string |
yes |
n/a |
the template parameter defines the name of the template that will be used for displaying the information (block). |
quota_id |
integer |
no |
n/a |
If you would like to display comments that are associated with artist from a specific Jamroom Quota, you can pass in the Jamroom Quota, or array of Jamroom Quotas (using the {jr_array} template function) and only comments for artists from the given Jamroom Quota(s) will be shown. |
band_id |
integer |
no |
0 |
The band_id is used to tell Jamroom that the comments you want to see should only be for a specific artist_id in Jamroom. You may also pass in an array of band_id's using the {jr_array} template function. |
song_id |
integer |
no |
n/a |
If you are using the song type, then you can pass a song_id to see comments for a single song. |
video_id |
integer |
no |
n/a |
If you are using the video type, then you can pass a video_id to see the comments for a single video. |
radio_id |
integer |
no |
n/a |
If you are using the radio type, then you can pass a radio_id to see the comments for a single radio station. |
photo_id |
integer |
no |
n/a |
If you are using the photo type, then you can pass a photo_id to see the comments for a single photo. |
event_id |
integer |
no |
n/a |
If you are using the event type, then you can pass an event_id to see the comments for a single event |
vault_id |
integer |
no |
n/a |
If you are using the vault type, then you can pass a vault_id to see the comments for a single vault entry. |
item_id |
integer |
no |
n/a |
If you are using the item type, then you can pass an item_id to see the comments for a single store item. |
message_id |
integer |
no |
n/a |
If you are using the message type, you can pass a message_id to see the comments for a single blog entry (message). |
show |
integer |
no |
"Page Results" setting in Jamroom Config |
You can pass in the optional "show" parameter which tells Jamroom you want to limit the amount of comments that are shown to the amount specified. |
tpl_dir |
string |
no |
theme |
The tpl_dir will tell the function which directory to find the display template in. Can either be "theme" or "skin". |
skin |
string |
no |
Active Skin Name |
If the template you would like to use to display the comments is not located in the Active Skin directory, you can specify the skin name where Jamroom can find the template. |
theme |
string |
no |
n/a |
If the template you would like to use to display the comments is located in a theme directory, you can specify the theme name where Jamroom can find the template. |