{jr_theme_comment}
{jr_theme_comment} is used for embedding comments into a Jamroom Profile page template.
 |
Note: {jr_theme_comment} is a deprecated function, and should no longer be used in Jamroom 3.1 and newer. The {jr_ranking} template function can perform the same functions as the {jr_theme_comment} template function, but with better support. This page has been left here for reference purposes only. |
Parameters:
| Name |
Type |
Required |
Default |
Description |
| type |
string |
yes |
band |
the "type" parameter tells Jamroom what type of comment call you are making - song, video, message, item, vault, photo, video, band, event, etc. |
| show |
integer |
no |
n/a |
limits the number of entries returned to the "show" amount. |
| header_template |
string |
no |
n/a |
defines the template to use as the HEADER template for the output. |
| row_template |
string |
no |
n/a |
defines the template to use as the ROW template for the output. |
| footer_template |
string |
no |
n/a |
defines the template to use as the FOOTER template for the output. |
| tpl_dir |
string |
no |
"skin" |
directory containing the Jamroom template - can be "skin" or "theme" |
| theme |
string |
no |
n/a |
if a tpl_dir value of "theme" is given, then the name of the Artist Theme needs to be passed in with the theme parameter |
| skin |
string |
no |
n/a |
The skin parameter tells the function to look in the skins/<skin_name> directory to find the template. If this is not supplied, the function will look in the Active Skin directory. |
| band_id |
mixed |
no |
n/a |
If a single band_id (or array of band_ids) is is given, then only comments from the given ID's will be returned. Can be used in conjunction with other ID types. |
| message_id |
mixed |
no |
n/a |
If a single message_id (or array of message_ids) is is given, then only comments from the given blog message ID will be returned. |
| song_id |
mixed |
no |
n/a |
If a single song_id (or array of song_ids) is is given, then only comments on the given song will be returned. |
| video_id |
mixed |
no |
n/a |
If a single video_id (or array of video_id)s is is given, then only comments on the given video will be returned. |
| message_id |
mixed |
no |
n/a |
If a single message_id (or array of message_ids) is is given, then only comments from the given message ID will be returned. |
| item_id |
mixed |
no |
n/a |
If a single item_id (or array of item_ids) is is given, then only comments from the given store item will be returned. |
| assign |
string |
no |
n/a |
optional "assign" parameter - if given, the output of the function will be assigned to a template variable of the same name. |
Examples:
embedded {jr_theme_comment} function call in template, displaying comments on an event:
| {jr_theme_comment type="event" band_id=$BAND_ID event_id=$EVENT_ID template="jr_theme_comments.tpl" tpl_dir="skin" skin="Cobalt"} |
embedded {jr_theme_comment} function call in template, displaying comments on a blog message:
| {jr_theme_comment type="message" band_id=$_blog.BAND_ID message_id=$_blog.MESSAGE_ID template="custom_comments.tpl" tpl_dir="skin" skin="custom01"} |
|
