Fields Module

Implement quick one click listing searches for a field's option values. Works with select, radiobutton and checkbox listing custom fields. Click the option and getlisting results matching the clicked value.

Overview

Similar to Click2Search, but outside of listings, you can use the Field Joomla module and WordPress widget to generate quick listing search and navigation links for field options.

For example, this can be useful for restaurants to show a list of cuisines in the sidebar to let users click one to filter the results. In the case of movies, users can click on genre or MPA rating for filter the results.

The main difference between the other search options mentioned above and this one is that the fields module/widget only allows filtering results for a single custom field option. This allows:

Getting Started

  1. Publish the Module/Widget

    Find the Fields Module in Joomla or the Fields Widget in WordPress and assign it to the position of your choice and publish it.

  2. Set the custom field name

    Fill out the Field name setting with the name of the field for which you want to display the field option links

  3. Adjust the settings

    • Display Mode - links vertical, tag, tag cloud, dropdown list
    • Option Listing Count
    • Option Images
    • Option Ordering - alphabetical, listing count, pre-defined ordering
  4. Enable search in the fields manager

    In the fields manager check that the field is enabled for search. This is the toggle under the search icon header in the list of fields.

With this you have a basic setup, enough to show the options on the site in the published position. The system will try to use the context of the page to automatically show the field options that are in use and will lead to results when clicked.

Filtering Mode

The filtering mode setting can be used to automatically change the generated links to filter the results. The available modes are:

  • Current Page Category

    Adds the category filter to the results and uses the current category as the base URL for option links and a

  • Current Page Listing Type

    Adds the listing type filter to the results. If an advanced search menu exists for this listing type, it's URL will be used as the base URL. Otherwise, the main advanced search menu is used.

  • No Filtering (Using Adv. Search Menu)

    Default mode which generates links based on the advanced search menu URL structure.

  • No Filtering (Using Hardcoded Menu ID)

    Allows using a menu ID in Joomla, or a page ID in WordPress, as long as they are JReviews pages. For example, if there is a City Guide directory with a menu/page ID of 333, you select this mode and fill out the ID below it. The option links will then use the URL for this menu as the base URL

Drill Down Mode

This is how you take advantage of field option relations with a single module/widget for navigation purposes. You click on a field option link, and the output automatically changes to load the dependent field options from another field.

The most popular use-case for this is location navigation using State and City fields. You click on California, the page reloads to show the listings in California, and at the same time the output of the module/widget changes to load the cities options in the City field for California.

To use the feature, just enable Drill Down Mode and make sure that the module/widget is visible on the result page. In Joomla, if the results page uses default filtering mode (ADv. Search Menu), the module needs to be published to that menu.

There's a few other settings here:

  • Click2search Drill Down Fields (optional)

    Comma list of dependent field names that will trigger the drill down mode in click2search URLs. This is required when placing multiple drill down field modules on the same page.

  • Control Field and & Control Value (optional)

    Use to display a subset of options for a field. For example, with the State and City setup, if you only want to show cities in California, you would use jr_city as the field name in the Main Setup. Then use these settings to set the control field as jr_state and the control value as california.

    These settings force the drilldown behavior in non-click2search pages. Otherwise, using the jr_city field would show all fields in all states.

Custom URL Parameters

If you need a bit more control over the filtered results when an option is clicked, you can use this setting which allows adding custom url parameters to the generated field option URLs.

Custom Ordering

One use-case for this is to change the ordering for the results to use a custom order. For example, if you are showing a list of brands, you can include ordering based on product prices:

order=jr_productprice

You can also use any of the default ordering options to show results by most recent, top rated, etc. You can perform a standard search and then re-order use the ordering list to see the different order values in the URL that you can use for custom params.

Extra Filters

To add extra filtering parameters to the generated links, include the parameters as you see them in search URLs. Check the custom params page for ideas.

To include filters for other custom fields:

jr_fieldname=value

If add additional fitlering parameters, you should hide the listing count because the count will only reflect results for the the main field settings, not the custom parameters.

Custom Theme Suffix

To force the search results output template to load with a specific theme suffix, you can also pass it as a parameter:

tmpl_suffix=_suffix1