blog documentation FAQ forum marketplace youtube

Search

The Jamroom Network » Documentation » Module Reference » Search
Applies to: Jamroom 7.0+ Last verified: 2026-10-24

Table of Contents:


What it does
How searching works
Searching your own fields
Global Config
For template designers
Function {jrSearch_form}
Function {jrSearch_module_form}

  • What it does

    Search adds site-wide search. Visitors search everything at once, and see the best matches from each kind of item: profiles, audio, blog posts and so on. Skins put a search box in the header. Modules can add their own search box that searches only their items. It comes with Jamroom.

    ACP > Modules > Listing > Search

  • How searching works

    Search Method decides how a search is read:

    • Default: a search of 5 or more words without AND, OR or NOT is read as a natural-language phrase. Shorter ones are read as keywords.
    • Keyword Only: every word is a keyword, and AND, OR and NOT combine them.
    • Natural Language Only: every search is read as a phrase or question.

    If nothing matches exactly, Include Partial Matches runs a second search for words that contain the search term.

  • Searching your own fields

    Fields you add with the Form Designer aren't searched until you list them under Additional Search Fields, one per line. Add a weight to make a field count more: profile_location,10 makes a match there 10 times as important.

    If results are missing, run Tools > Rebuild Indexes.

  • Global Config

    Search Options

    Setting What it does
    Additional Search Fields Extra fields to search, one per line, with an optional weight
    Include Partial Matches Searches for partial words when there are no exact matches (default: on)
    Optimize Queries Speeds up some searches. Turn it off only if result pages look inconsistent. (Default: on)
    Log No Results Logs searches that found nothing to the Activity Log (default: off)
    Search Method Default, Keyword Only, or Natural Language Only (see above)

    Display Options

    Setting What it does
    Index Result Count Results shown from each module on the main results page (default 4)
    Module Result Count Results per page when viewing one module's results (default 12)
    Search Result Order The order of the modules on the results page. Click Set Result Order to change it.

    Index Options and Disabled Modules

    Setting What it does
    Unique Module Indexes Gives a module its own search index. It can speed up searches in modules with very many items. Most sites should leave it empty.
    Disabled Modules Modules whose items are never searched or indexed

    The Site Search widget puts a search box on a Site Builder page.

  • For template designers

    The site-wide search box:

    {jrSearch_form class="form_text" value="Search Site" style="width:70%"}

  • {jrSearch_form}

    Function
    {jrSearch_form}
    parameter
    type
    default
    required
    description
    module
    string
    all
    off
    Search one module only, such as jrBlog
    value
    string
    search site
    off
    Placeholder text in the search box
    page
    int
    1
    off
    The page of results to show
    pagebreak
    int
    4
    off
    Results per page
    method
    string
    post
    off
    Form method: post or get
    class
    string
    -
    off
    CSS class for the search box
    style
    string
    -
    off
    CSS style for the search box
    template
    string
    -
    off
    A custom template for the search form
    tpl_dir
    string
    -
    off
    Where that template is, if not in the active skin
    assign
    string
    -
    off
    Put the output in this variable instead of showing it

    Shows the site-wide search form.

  • A search box for one module's index page, searching only the fields you name:

    {jrSearch_module_form module="jrBlog" fields="blog_title,blog_text"}

  • {jrSearch_module_form}

    Function
    {jrSearch_module_form}
    parameter
    type
    default
    required
    description
    module
    string
    -
    on
    The module to search. Not needed in a module's own index.tpl.
    fields
    string
    -
    on
    The fields to search, comma separated, such as blog_title,blog_text
    template
    string
    -
    off
    A custom template for the search form, in the active skin
    assign
    string
    -
    off
    Put the output in this variable instead of showing it

    Shows a search form for one module.

Tags