Jamroom Logo Jamroom 5 Core
is now Open Source!
Follow Jamroom on Twitter!

{jr_rating_image} Index {jr_submit_digg}

{jr_search}


The {jr_search} template function is used for embedding the output of a Jamroom Search call directly in to a non-profile Template.

Note: {jr_search} is a deprecated function, and should no longer be used.  The {jr_ranking} template function can perform the same functions as the {jr_search} template function, but with many additional features and better support.  This page has been left here for reference purposes only.

Parameters:

Name Type Required Default Description
search_area string yes n/a The "search_area" parameter tells Jamroom the area you want to run the search in.  Reference the Jamroom Advanced Search documentation for a list of available search areas.
search_string string yes n/a The "search_string" parameter is used for defining the string of text you would like to search for in the given search_area.
order_by string no n/a The "order_by" parameter tells Jamroom you would like the output results to be ordered in a specific order.  Please reference the Jamroom Advanced Search documentation for a list of valid order_by values.
order_direction string no ASC If you are passing in an order_by value, you can also specify the order direction - either ASCending or DESCending.  Default is "ASC" for ascending - use a value of "DESC" to indicate descending order.
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.
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_search} function call in a Template:

{jr_search search_area="all_song" search_string="guitar" header_template="custom_search_header.tpl" row_template="custom_search_row.tpl" footer_template="custom_search_footer.tpl"}

{jr_rating_image} page 143 of 171 {jr_submit_digg}
Solutions Products Support Community Company
Social Media Platform
Social Networking Software
Musician Website Manager
Community Builder
Jamroom 5
Jamroom 5 Modules
Jamroom Marketplace
Support Forum
Documentation
Support Center
Contact Support
Community Forum
Member Sites
Developers
About Us
Contact Us
Privacy Policy
©2003 - 2024 The Jamroom Network