Super Search 3.x

Legacy documentation for Super Search 3.x.

Introduction to Super Search

The most basic setup of Super Search needs only 2 things:

Search Form

All the search form (Super_Search:Form) needs to do is post (either by POST or GET) form data to the results page. The most common usage of Super Search, involves usage of the keywords field.

{exp:super_search:form
    return="supersearch/results"
}
    <label for="keywords">Keywords</label>
    <input
        type="text"
        name="keywords"
        id="keywords"
        value="{super_search_keywords}" />
    <input type="submit" value="Search!" />
{/exp:super_search:form}

That's literally everything you need for the most basic search form.

The {super_search_keywords} variable is a global variable that gets dynamically assigned on the results page to allow you to repopupate the search form. If the current page has no search results loop it becomes an empty string.

Diagram: Search Forms in Super
 Search

Results Page

On the search results page, you'll need to use the Super_Search:Results tag.

Your results template could look something like this:

{exp:super_search:results}
    <div class="entry">
        <h3>{title}</h3>
        <p>{body}</p>
    </div>
{/exp:super_search:results}

You can consider the Super_Search:Results loop as an extended version of the Channel:Entries loop. All the same variables are available, with some additions and alterations.

A full list of the additional variables available within the Super_Search:Results loop are available here.

Taking it Further

At the basic level, Super Search enables searches and results display from across your sites, but it can do a lot more than basic keyword searching when you need it.

For an idea of what you can do with it, have a gander over the available options and paramaters, and have a look at the other guides in the Super Search documentation.