Documentation - Custom Filters Starter


This document offers the basic knowledge for installing , configuring and using the extensions that consist the Starter version of the custom filters suite.

This document is copyrighted © 2012-2019 and is licensed under the terms of Creative Commons Attribution-NoDerivs 3.0 Unported (CC BY-ND 3.0) License [].

You can distribute it freely as long as you do not modify it and state its source and/or author. You can use this document or any portion of it for commercial purposes too.

Notice — For any reuse or distribution, you must make clear to others the license terms of this work. The best way to do this is with a link to the author's web page.

If you require further permissions, for example to do changes to the current document and disctribute it to your clients, please email the author in order to acquire such a license and the source to this document.

About cf filtering module

The module displays the filtering form in the Fron-end of the site. It contains the necessary functionality for displaying the desired filtering options, used for filtering the products of a Virtuemart eshop.

About Custom Filters Component

The PRO version of the component is used for generating filters from the custom fields of Virtuemart. It is also used for managing their display in the module.
In the front-end the component is responsible for the filtering process and the results display.

  1. Joomla 3.8.1 and higher
  2. Virtuemart 3.x
  3. PHP 5.4.x
  4. MySQL 5.0.4+


After downloading the package from our site, just install it using the joomla installation process.



To update your version just download the latest version of the extension and reinstall it without uninstalling your current version. The upgrade will be done smoothly.
After the update we recommend to visit the component's and the module's settings to check if there is any new setting.

After the installation you have to to create a menu item for the results page. This menu item will be actually the page where the results will be shown after using the module.

menu item creation

Since the results page will be the landing page of the module, we don't want that menu item to be visible in our site. So you should better create your menu item in a menu which is not displayed in the front-end. If such menu does not exist you better create it.

Select as menu item type the CustomFilters > Results page

menu item selection

After selecting the menu item type, just fill in the appropriate fields and parameters

menu item parameters

You will find some important parameters here such as the Products per row, for setting how many products will be displayed in each row in the results. The Pagination default value which sets the number of products displayed in each page and also the Pagination list values which sets the options of the pagination list.
Also you can select alternative layouts for the results using the Choose layout setting. Custom Filters use the Virtuemart's category layout for displaying the results. So if you have multiple category layouts using template overrides, you can alter your layout for the results.


Configure the Component

It's the component that takes care of the filtering process.
Now you have to configure it, to get the optimal results.

Go to Components > Custom Filters
Press the Options button to open the configuration page. The most important settings here are:

Basic settings

  1. Return as results
    It defines whether the results will be parent or the child products.
    In case of child products, the category and the manufacturer fields will be traced from their parent products
  2. Reseting all variables returns
    What will be returned if no filter is selected. No products is recommended for big shops
  3. Products in multiple shopper groups
    Enable this only if you have products assigned to specific shopper groups


Enable the Module

Time to display the module in the front-end of your site.

Find the CF Product Filtering & Search module in your modules manager. This module will display your filters.

As with every module, you have to set it's position in the template, publish it and assign it on the pages you want.

mod manager

After the installation you have to configure the module. So go to the Module Manager and select the cf filtering module.
As with every module, set its position in the template and publish it. Also set it to be displayed on the pages you want.

Basic Settings

Some settings that regard all the filters.

Dependency direction. It defines how the selections in a filter are affecting the
options in the other filters. Specifically it defines how the active options will be
There are 2 types of dependency direction:

a. All. Means that selecting an option in a filter will affect all the filters.

 dpendency dir copy

b.Top to Bottom. Means that selecting an option in a filter will affect only the filters which are placed after (below) that. This is useful for cases like the car > make > model where we want to narrow the options as we go deeper in the filters.

dpendency dirTtB copydpendency dirTtB2 copy

Use the varriables from Virtuemart pages.The module can use variables from the pages of Virtuemart. For example can use the category id from the category page or the productdetails page or use the manufacturer id from the manufacturer page. This is like auto selecting options from the appropriate filters using variables from the VM pages.

Use vm pages vars


Index options by search engines. This actually ads or not a “nofollow” to the created links. Links with “nofollow” are not indexed by the major search engines.

Filters ordering. With this setting you can order the filters the way you like

filters ordering copy

To order the filters just drag the options at the desired position using your mouse.


Common settings in all filters (Categories, Manufacturers)

The cf filtering settings are built in a way that offers control over the functionalities and the display of every type of filter. Each filter has its own pane with its own settings.

cat mod settins Starter

A filter has to be published to be displayed in the module. An unpublished filter won't be displayed no matter how the other parameters are set.

 Empty Options Display. Some options won't return products if selected. With this parameter you can set, how these options will be handled.
a. Show as disabled. Displays the options but the user cannot select them.
b. Hide.
c. Show as enabled. The user can select them even if they will return no products.

Display type
How the options of a filter will be displayed

1.Drop-down list (Single)
2.Radio buttons(Single)
3.Link (Single)

notice iconThe only way to select multiple options from a filter is to use checkboxes. (PRO package)


Display counter near the options

Counts the products and displays a counter near each option.


notice iconDisplaying a counter can have impact on the site performance in case of shops with thousands of products


Categories Filter settings

Order of Categories
With this setting you can define how the categories will be ordered in the module.

The available options are:
1.Category ordering (No tree) → The categories will be ordered using the ordering numbers you are using in VM.
2.Category Names → Orders the categories by their names in ascending direction.
3.Category Tree → Displays the categories as tree.

Display specific Categories
You can display only specific categories using that setting. All you have to do is to write the ids of those categories separated by comma in the Displayed Categories input.

cat ids

Exclude Categories
In order to exclude some categories from being used in the categories filter you have to
write their ids separated by comma in the Excluded Categories input.

If you get stuck and you need more help you can use our support services.
Our subscribers (excluding free subscriptions) are entitled to personalised, private support through our ticket system. They have also access to more resources and documents offered in our knowledge base.
To use the support area of our site, you have to login and click the “support” link, placed in the top menu of our site Support tickets are usually answered within 24hrs during office hours (GMT+2).

To get a subscription just visit our Subscriptions page and select the desired subscription plan.

If you have noticed any bug or you have any suggestion, feel free to report it through our Contact Form