WooCommerce AJAX Products Filter

1. Copy a Plugin key from BeRocket website
2. Paste it into WooCommerce AJAX Products Filter entry field
3. Click on Test button
4. It the proper Plugin key is entered, you’ll se
   
5. Press the Save Changes button

• The number of Attribute Values – the number of values, which will be displayed in the widget. Other values can be found by clicking on the button Show values. The Hide the Show/Hide value(s) setting must be disabled
• Scroll Top – scrolls the page back to top; after filtering, the page will be scrolled to the top with a margin in pixels specified in the field
  
• Values count and output – recounts and outputs values of categories/ attributes/ tags/ etc. for filter widgets:
  • All non-empty values are displayed; standard recounting is applied
  • All empty values are removed based on page (categories/tags/ etc.)
  • All non-empty values are displayed; filters are applied in recounting attribute values
  • All empty values are removed based on page (categories/tags/ etc.); filters are applied in recounting attribute values; all empty values based on applied filters will be hidden
  • Filters are applied in recounting attribute values; empty values are removed on the server-side
• Hide values:
  • Hide values without products – all attribute/category values will be hidden in filters with no products after filtering (the Show/Hide value(s) button will be output; by clicking on this button you will find Hidden values without products)
  • Hide selected values – all attribute/category values will be hidden in the filter widgets used in filtering (the Show/Hide value(s) button will be output; by clicking on this button you will find Hide selected values)
  • Hide empty widgets – some widgets will be hidden after filtering, if there are no products with such attributes/categories in those widgets
  • Hide the Show/Hide value(s) button in filters – hides the Show/Hide value(s) button; it is possible to enable it only when Hide values without products and Hide selected values are also enabled

• Hide out of stock variations – Disabled, Enabled, Controlled by “Out of stock” filter
  • Hide variable products, if variations with selected filters are out of stock: 
    • Use the option for attribute values, to display a more accurate count using Values count and output option
    • Fix issue with WPEngine request (works with other hostings only if they limit the size of the request)
• Display variation data:
  • Image – displays a picture of the variation, which matches the filter criteria, on a variable product after filtering
  • Price – displays the price of the variation that matches the filter criteria
• Remember variation options – after filtering, when opening a variable product, the attributes by which the filtering was performed will be selected
• Use variation options only after the search

• Elements position – the positioning of all elements, which will be output with the help of WooCommerce hooks. If there are no hooks, elements may be not output
  • WooCommerce description (in the header)
  • Before WooCommerce Shop Loop – Before Products
  • After WooCommerce Shop Loop – After Products
• Display selected filters – show selected filters over products
  • Hide the area of the selected filters if nothing is selected (affects only the area above the products)
• Show the number of products before filtering – this option works only if you click on the Products Filter button. A tooltip will be output where you can see the number of products which will be output after clicking on the Products Filter button. Start filtering by clicking on the Show button in the tooltip (can’t be used if Hide selected values is enabled)
  
• Elements over products – allows you to add Group Filters above all products

• Get selectors automatically – uses the script, which automatically searches for selectors in your theme, and then automatically places them in the selectors fields (may function not properly with certain themes). Three products and one category will be created to place selectors. These products and a category will be deleted after selectors are placed
• Products Selector – A selector for a tag that contains products. Do not change it if you do not know what it is
• Products Quantity Selector – a selector for a tag from the results of the quantity of products (“Showing 1–8 of 61 results”). Do not change it if you do not know what it is
• Products Sorting Selector – selector for the sorting block. Do not change it if you do not know what it is
• Products Pagination Selector – A selector for a tag that contains products. Do not change it if you do not know what it is

• Refresh URL when filtering – if this option is enabled, the URL will be changed when selecting / changing the filter
  • Use links for checkboxes and radio filter – in widgets, makes a category/attribute name a link that search bots can index:
    • Use noindex for links – noindex tag will be added to links
    • Use nofollow for links – nofollow tag will be added to links
  • Use slug in URL – use attribute slug instead of its ID. Do not use such symbols as “-“, “_”, “+”, “*”, “№”, etc. in slug
  • Nice URLs – works only with the SEO-friendly URLs. WordPress permalinks should be linked to the Post Name (custom structure: /%postname%/)
  • URL decoding – decrypts characters in a URL to avoid server-side errors
• Base Canonical URL – use the canonical tag without filters on WooCommerce pages
• SEO Meta, Title
  • SEO Elements – you can select the elements that SEO Meta and Titles will be used for
    • Title
    • Header
    • Description
  • SEO elements structure – you can select the structure of the selected filters construction
    • {title} with [attribute] [values] and [attribute] [values]
    • {title} [attribute]:[values];[attribute]:[values]
    • [attribute 1 values] {title} with [attribute] [values] and [attribute] [values]
    • {title} – [values] / [values]

• Products per page – sets the number of products on page
• Display products – always displays products, when filters are selected. Use the option when have categories and subcategories on the pages of your shop, and you want to display products when filtering
• Use Taxes in Price Filters – allows you to use taxes in the price filter widget and the price range; the option works only for “Standard rates”
  
• Page same as filter – on the pages of category/tag/filter attribute the value for a filter will be removed, or only one value will be left
  • Default – all values will be output in the filter widget
  • Delete value – deletes selected value in the filter widget
  • Leave only one value – deletes all values in the filter widget
• Data Cache – allows you to choose the caching option for filters
  • Disabled – disables filter caching
  • WordPress Cache – uses WordPress Caching
  • Persistent Cache Plugins – uses other plugins for caching (e.g. W3 Total Cache, WP Super Cache)

• Disable all filters – if you want to hide filters without losing the current configuration, just disable them.
• Disabled admin bar – Disable panel in WordPress Admin Bar
• Purge cache – clears the attribute/custom taxonomy cache for plugin. 

• Display styles only for pages with filters – adds styles only for pages with filters
• Fix for site with AJAX – fixes for sites that uses AJAX
• Fix for a search page – disables redirecting, when a search  returns only one product
• Slider has many values – enable the setting if the slider has more than 250 values. Hierarchical taxonomy may not work correctly with sliders
• Select2 CSS – fixed CSS styles for Select2 (do not enable, if Select2 works correctly. The option may break Select2 in other plugins or themes)
• Fix WPEngine query issue – can also work with other hostings if they limit query size.

• Loading icon – allows you to upload an image for the download animation
• Loading icon text – text and its position when loading products: 
  • Above – above the loading icon
  • Below – below the loading icon
  • Before – before the loading icon
  • After – after the loading icon
• Show and hide description – settings for Show and hide descriptions:
  • Open on:
    • click
    • hover
  • Hide on:
    • clicking anywhere
    • cursor is outside the icon
• Style for number of products – style of counting products
• Indent for hierarchy in Drop-Down:
  • –
  • space
  • 2 spaces
  • Tab

• Collapse Button style – choose the Open Sidebar button style/filters dropdown [maximization]
• Collapse Button Icon style – choose an icon for the button
• Sidebar Shadow – choose the shadow style on opening the sidebar

• Filters Description
• Color/Image Tooltip Name
• Products Count Before Update – tooltip style with the product count before filtering

• Title – allows you to customize the display styles on the shop pages for Filter Name
• Title when opened – allows you to customize the display styles on the shop pages for Filter Name when opened
• Filter – allows you to customize the display styles on the shop pages for a filter when the filter is open

• Disable Font Awesome – Don’t loading css file for Font Awesome on site front end. Use it only if you doesn’t uses Font Awesome icons in widgets or you have Font Awesome in your theme
• Font Awesome Version – Version of Font Awesome that will be used on front end. Please select version that you have in your theme
• Before Update – a field for executing Javascript before filtering
• During Update – a field for executing Javascript during filtering
• After Update – a field for executing Javascript after filtering
• Custom CSS Style – custom CSS field

Additional Tables (BETA)

Nested Filters (BETA)

Link like WooCommerce (BETA)

Custom Sidebar

Custom Search (BETA)

Custom Slug (BETA)

In the Conditions for Page ID, you can choose on which pages to display filter widget(s)

If you select Equal, widget(s) will be displayed on the selected pages
If you select Not Equal, the widget(s) will not be displayed on the selected pages

In the Conditions for the Product Category, you can choose on which categories to display filter widget(s)

If you select Equal, widget(s) will be displayed on the pages of the selected categories
If you select Not Equal, widget(s) will not be displayed on the pages of the selected categories

In the Conditions for the Product Attribute, you can choose for which pages, attributes or tags to display the widget(s)

If you select Equal, widget(s) will be displayed on the selected attribute or tag pages
If you select Not Equal, the widget(s) will not be displayed on the selected attribute or tag pages

In the Conditions for Product Search Page, you can choose to display filter(s) on products search page or not

If you select Equal, widget(s) will be displayed on the products search page
If you select Not Equal, the widget(s) will not be displayed on the products search page

The Filter widget displays filters by Attribute, Tags, Product Subcategories, Custom Taxonomy, Stock Status, Date, Sale Status, Product Category, Rating, Brands

Filter by:

Operator

Value Sorting

Sorting type

The Apply Filters button widget adds a filtering button, until the button is pressed, filtering will not be performed

Widget Filter Reset Button – Adds a button to reset the selected filters

Hide button – setting to hide the reset button

• Do not hide – the reset button will always be displayed
• Hide only when there are no filters on the page – the reset button will be hidden when there are no filters on the page
• Hide when there are no filters on the page or the page is not filtered

Widget Area Selected Filters

• Show if nothing is selected – show the widget without the selected filters
• Hide arrow to collapse widget?
• Hide this widget on load?

• Custom CSS class – you can set a custom class for a group
• Show filters above products
  
• Filters in line
  • Maximum number of filters per line
• Show title only – when the setting is enabled, the filters will be minimized
  
  • Display on mouse over and hide on mouse leave
• Filters in this Group – add filters to a group for display on store pages

To create a Search Box you need:

• in the group add the necessary filters for the Search Box
• enable the Use Group as a Search Box option in the Search Box section
  
• select the settings you need in the Search Box section
  • Search page url – select which page will toggle after using the Search Box
    • Shop page – redirect to the default shop page
    • Category page – redirect to the category page
      • Category – you can choose which category will redirect the page to
    • URL – user’s url
      • Custom url – you can specify any link

Called before converting the data in a link to the required format for further use.

Used to display additional settings in filter groups.

Parameters

• $filters – array of values of all settings in the group 
• $post_name – field name used to save settings
• $post – post with the settings

Links all styles of filters. Used to get information about all styles and display all styles on the filter creation page. You can link styles from other plugins or themes.

Adding new styles to the theme

The plugin automatically links all styles from the themes, put to the braapf-template-styles directory.

To generate HTML markup a special array with all the necessary parameters is used, which can be changed if necessary using the filter hooks.

Example of filter base structure

array(1) {
  ["template"]  => array(4) {
    ["type"]        => string(3) "tag"
    ["tag"]         => string(3) "div"
    ["attributes"]  => array(5) {
      ["class"]         => array(2) {
        [0]               => string(12) "bapf_sfilter"
        ["filter_type"]   => string(10) "bapf_ckbox"
      }
      ["data-op"]       => string(2) "OR"
      ["data-taxonomy"] => string(7) "pa_size"
      ["data-name"]     => string(6) "Size"
      ["id"]            => string(6) "bapf_1"
    }
    ["content"]     => array(2) {
      ["header"]      => array(4) {
        ["type"]        => string(3) "tag"
        ["tag"]         => string(3) "div"
        ["attributes"]  => array(1) {
          ["class"]       => array(1) {
            [0]             => string(9) "bapf_head"
          }
        }
        ["content"]     => array(1) {
          ["title"]       => array(4) {
            ["type"]        => string(3) "tag"
            ["tag"]         => string(2) "h3"
            ["attributes"]  => array(0) {
            }
            ["content"]     => array(1) {
              ["title"]       => string(6) "Size"
            }
          }
        }
      }
      ["filter"]      => array(4) {
        ["type"]        => string(3) "tag"
        ["tag"]         => string(3) "div"
        ["attributes"]  => array(1) {
          ["class"]       => array(1) {
            [0]             => string(9) "bapf_body"
          }
        }
        ["content"]     => array(1) {
          ["list"]        => array(4) {
            ["type"]        => string(3) "tag"
            ["tag"]         => string(2) "ul"
            ["attributes"]  => array(0) {}
            ["content"]     => array(3) {
              ["element_0"]   => array(4) {
                ["type"]        => string(3) "tag"
                ["tag"]         => string(2) "li"
                ["attributes"]  => array(0) {}
                ["content"]     => array(2) {
                  ["checkbox"]    => array(3) {
                    ["type"]        => string(8) "tag_open"
                    ["tag"]         => string(5) "input"
                    ["attributes"]  => array(4) {
                      ["data-name"]   => string(1) "L"
                      ["id"]          => string(10) "bapf_1_558"
                      ["type"]        => string(8) "checkbox"
                      ["value"]       => int(558)
                    }
                  }
                  ["label"]       => array(4) {
                    ["type"]        => string(3) "tag"
                    ["tag"]         => string(5) "label"
                    ["attributes"]  => array(1) {
                      ["for"]         => string(10) "bapf_1_558"
                    }
                    ["content"]     => array(1) {
                      ["name"]        => string(1) "L"
                    }
                  }
                }
              }
              ["element_1"]   => array(4) {
                ["type"]        => string(3) "tag"
                ["tag"]         => string(2) "li"
                ["attributes"]  => array(0) {}
                ["content"]     => array(2) {
                  ["checkbox"]    => array(3) {
                    ["type"]        => string(8) "tag_open"
                    ["tag"]         => string(5) "input"
                    ["attributes"]  => array(4) {
                      ["data-name"]   => string(1) "M"
                      ["id"]          => string(10) "bapf_1_559"
                      ["type"]        => string(8) "checkbox"
                      ["value"]       => int(559)
                    }
                  }
                  ["label"]       => array(4) {
                    ["type"]        => string(3) "tag"
                    ["tag"]         => string(5) "label"
                    ["attributes"]  => array(1) {
                      ["for"]         => string(10) "bapf_1_559"
                    }
                    ["content"]     => array(1) {
                      ["name"]        => string(1) "M"
                    }
                  }
                }
              }
              ["element_2"]   => array(4) {
                ["type"]        => string(3) "tag"
                ["tag"]         => string(2) "li"
                ["attributes"]  => array(0) {}
                ["content"]     => array(2) {
                  ["checkbox"]    => array(3) {
                    ["type"]        => string(8) "tag_open"
                    ["tag"]         => string(5) "input"
                    ["attributes"]  => array(4) {
                      ["data-name"]   => string(1) "S"
                      ["id"]          => string(10) "bapf_1_560"
                      ["type"]        => string(8) "checkbox"
                      ["value"]       => int(560)
                    }
                  }
                  ["label"]       => array(4) {
                    ["type"]        => string(3) "tag"
                    ["tag"]         => string(5) "label"
                    ["attributes"]  => array(1) {
                      ["for"]         => string(10) "bapf_1_560"
                    }
                    ["content"]     => array(1) {
                      ["name"]        => string(1) "S"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Filtering of elements of a single Checkbox filter value; select for building HTML code.

Parameters

• $element – array with elements
• $term – value of the attribute, for which HTML is generated
• $i – indicates the order number of the attribute
• $berocket_query_var_title – all parameters for the current filter

Filtering of all elements of one filter for building HTML code.

Parameters

• $template_content – array with filter elements
• $terms – all attribute values for this filter
• $berocket_query_var_title – all parameters for the current filter

Filtering of Update button, Reset button, Selected filters area for building HTML code.

Parameters

• $template_content – array with widget elements
• $berocket_query_var_title – all parameters for this widget

Get a list of all styles that were already connected.

Parameters

• $custom_taxonomies_list – list of taxonomies with required data

All parameters for the get_terms WordPress function

Parameters:

• $args – an array with arguments that will be used for the get_terms function;
• $filter_data – the filter settings, that were set when the filter was created;
• $widget_args – the widget parameters.

Additional parameters that are used to change the values received from the get_terms WordPress function.

Parameters:

• $additional – an array with additional parameters:
  • hierarchical(boolean) – sorts values hierarchically;
  • depth(int) – all child elements, that are deeper than this value in the hierarchy, will be deleted; if the value is set to zero, nothing will be deleted;
  • operator(string) – the operators used in the product count in values can be either OR, or AND;
  • recount_tax_query(array) – the tax_query array, which is going to be used in recalculating the values, is taken from the current query for products by default;
  • disable_recount(boolean) – disables the recalculation of the values based on the other filters and variations (depends on global settings);
  • disable_hide_empty(boolean) – disables deleting values without products for the page. If the attribute value is not used in any product (in store as a whole), the value is deleted anyway
• $filter_data – the filter settings, that were set when the filter was created
• $widget_args – the widget parameters
• $get_terms_args – parameters for the get_terms WordPress function

Checks if filters are applied on the current page.

Parameters

• $is_filtered – filters applied or not
• $place – name of the location where the hook is called

List of values for “Position of selected filters” option in plugin settings in SEO tab.

Parameters

• $options – array with values where each element is an array with the following structure: array(“value” => “function_name”, “text” => “Visual name in the drop-down list”)

You can declare the “function_name” function in the function.php file of the topic or anywhere else where it will be publicly available.

Parameters of the “function_name” function

• $filters – current generated text, usually an empty string
• $text – initial text for the current section
• $section – section name (header, title, description)
• $terms_filtered – array of current filters

Skip attribute value when making a list of filters to display in title, header, description page

Parameters

• $skip – miss the value or not (initially false)
• $term_parsed – array of data about the value of an attribute (may differ depending on the filter type)

Changes the attribute name for title, header, description blocks of the page.

Parameters

• $taxonomy_label – attribute name
• $taxonomy – object of attribute taxonomy
• $term – current value of the taxonomy (can be an array of values)
• $term_parsed – array of data about the value of an attribute (may differ depending on the filter type)

Changes the name of the attribute value for the use in title, header, description blocks of the page.

Parameters 

• $term_name – name of attribute value
• $term – current value of the taxonomy (can be an array of values)
• $taxonomy – object of attribute taxonomy
• $term_parsed – array of data about the value of an attribute (may differ depending on the filter type)

Change the price name for the use in title, header, description blocks of the page.

Parameters

• $price_name – price name. Applied __(‘Price’, ‘woocommerce’).

Change the text of the price value for the use in title, header, description blocks of the page.

Parameters 

• $price_name – text of price value 
• $price_data – all price data available on filtering
• $prices – array with initial price and final price

Text replacement for title, header, page block description. This hook is connected to the function that is selected in the settings.

Parameters

• $text_return – text to be used; initially an empty string
• $text – initial text
• $section – section name (title, header, description)
• $terms_filtered – array with data of all selected filters

Text replacement for title, header, page block description. This hook is called after the replacement and verification, and presents the finished text.

Parameters

• $text_return – text to be used
• $text – initial text
• $section – section name (title, header, description)
• $terms_filtered – array with data of all selected filters

Hook of obtaining HTML code to create a new element for widgets. Possible values $type: single, group.

Parameters

• $html – HTML code of the form for creating a new element

Hook for saving a new element for widgets. Possible values $type: single, group.

Parameters

• $data – array with data about the new element of an array format (‘value’ => $post_id, ‘name’ => $element_name, ‘name2’ => $element_title, ‘edit’ => $edit_post_link)

Current page without GET query and filters.

Parameters

• $current_page_url – current page URL without GET query and filters
• $options – array with plugin settings

Array filtering with settings for JavaScript.

Parameters

• $settings – an array with settings

Checks whether the WooCommerce short code should be filtered or not.

Parameters

• $is_filter -the WooCommerce short code should be filtered (boolean)
• $query_vars – shortcode data array for WP_Query
• $atts – array of shortcode attributes
• $name – shortcode name

Filtering of array with the ID of products to be excluded. Used to exclude variable products where no suitable variations are available.

Parameters

• $products – array with product ID
• $terms – array with filters that are applied
• $limits – array with filter-sliders, which are applied

Filtering of array with parameters for WP_Query. The array already contains all filters and limitations.

Parameters

• $query_vars – array with parameters for WP_Query
• $terms – array with filters that are applied
• $limits – array with filter-sliders, which are applied

Filtering of the check whether the current query  is the main one for WooCommerce.

Parameters

• $is_wc_main_query – current query is the main one (boolean)
• $query – WP_Query object, query
• $is_shortcode – filtering of WooCommerce shortcode (boolean)

Filtering WP_Query. Already contains filters and limitations.

Parameters

• $query – WP_Query for getting products with filters
• $terms – array with filters that are applied
• $limits – array with filter-sliders, which are applied

Filtering of any WP_Query query that passes through a filtering function, regardless of whether filters are added to it or not.

Parameters

• $query – WP_Query query
• $is_shortcode – WooCommerce short code (boolean)

Filtering of meta key for product price.

Parameters

• $price_meta_key – meta key for price;  _price by default
• $position – hook position name

Filtering of parameters to be added to WP_Query to filter products.

Parameters

• $args – array with parameters for WP_Query

Filtering of parameters for a group of filters, before displaying all filters. It is also used to output additional blocks before the filter group.

Parameters

• $custom_vars – array with additional parameters for the group
• $group_settings – group of filter settings

Filtering of arguments in a group of filters that are applied to all filters.

Parameters

• $new_args – array with parameters for filter widget
• $group_settings – group of filters settings
• $custom_vars – array with additional parameters for the group

Filtering of arguments in a group of filters that are applied to each filter.

Parameters

• $new_args – array with parameters for the filter widget
• $group_settings – group of filters settings
• $filter – filter ID
• $custom_vars – array with additional parameters for the group

Filtering of parameters for a group of filters, before displaying each filter. It is also applied to output additional blocks before each filter in the  group of filters.

Parameters

• $custom_vars – array with additional parameters for the group
• $group_settings – group of filter settings

Filtering parameters for a group of filters, after each filter is displayed. It is also used to output additional blocks after each filter in the filter group.

Parameters

• $custom_vars – array with additional parameters for the group
• $group_settings – group of filter settings

Filtering of parameters for a group of filters, after all filters are displayed. Also applied to display additional blocks after the filter group.

Parameters

• $custom_vars – array with additional parameters for the group
• $group_settings – group of filter settings

Filtration of array with filter types.

Parameters

• $filter_type_array – array of filter types with parameters

Hook to get data from the cache; initially returns false. When caching is enabled in the plugin, the function to return data from the cache is bound to this hook.

Parameters

• $data – cache data
• $key – key for caching
• $group – group for caching

Hook to store data in a cache, initially returns true. When caching is enabled  in the plugin, the function to save data to the cache is bound to this hook.

Parameters

• $set_result – data saved (boolean)
• $key – key for caching
• $value – value to save
• $group – group for caching
• $expire – cache saving time

Filtering of array with all WooCommerce product attributes.

Parameters 

• $attributes – array with all product attributes

Filtration of array of all taxonomies by which the products are filtered.

Parameters

• $taxonomies – array of taxonomies

Filtering of operators array for all taxonomies by which products are filtered.

Parameters

• $taxonomies_operator – array of operators for taxonomies

Filtering of attribute when added to tax_query for WP_Query by products

Parameters

• $taxonomy – an array with parameters for one tax_query element

Filtering of price slider values when identifying filters in a link.

Parameters 

• $prices – array with prices: from – to price

Filtering of array with widget types for filter settings.

Parameters

• $widget_types – array with widget types

Filtering of settings of widget with filters

Parameters

• $instance – array with filter settings

Filtering parameters for widget with filters.

Parameters 

• $args – array with parameters of widget

Filtering of text before price, can be set up in the price filter.

Parameters

• $text – text before the price

Filtering of text after price, can be set up in the price filter.

Parameters 

• $text – text after the price

Apply to prevent filters from being output. Applied to output specific filters.

Parameters 

• $not_display – do not output filters; false by default
• $widget_type – filter widget type
• $instance – filter settings
• $args – widget parameters
• $object – object BeRocket_AAPF_Widget class for calling required functions

Filtering of wp_term values to be used in filter when outputting.

Parameters

• $terms – array with attribute values

Filtering of custom classes, which will be added to the widget.

Parameters

• $classes – string with classes to be added, may be empty

Filtering of CSS styles, which will be added to the widget.

Parameters

• $styles – string with styles to be added, may be empty

Filtering of the minimum price value from a selected range of values.

Parameters

• $price – minimum price
• $base_price – initial minimum price before all filters

Filtering of the maximum price value from a selected range of values.

Parameters

• $price – maximum price
• $base_price – initial maximum price before all filters

Filtering of all values that are passed to the filter output template.

Parameters

• $parameters – array of all parameters for transmitting
• $type – filter type
• $instance – all filter settings

Filtering of the minimum price value from the selected value interval and from the minimum available value.

Parameters

• $price – minimum price

Filtering of the maximum price value from a selected range of values and from the maximum available value.

Parameters

• $price – maximum price

Filtering of the data that the get_price_range function returns.

Parameters

• $price_range – array of two values of the minimum price and the maximum price; false, if the price is not indicated

Filtering of part of the request with WHERE to remove products that are not available when checking variable products.

Parameters

• $query – string with request

Filtering of request to get variations that are not available for the current filters.

Parameters

• $query – request as an array
• $input – initial data
• $terms – selected filters
• $limits – selected sliders
• $current_attributes – attributes in filters
• $current_terms – attribute values in filters

Filtering of data, used in Update button, Reset button, Selected filters area.

Parameters

• $set_query_var_title – all parameters
• $additional – additional parameters for the element

Filtering of data used to recount the number of products for attribute values.

Parameters

• $taxonomy_data – all data
• $terms – list of all values of the attribute

An array of filtering using tax_query taxonomies, which is applied in the request for recounting the number of products for attribute values.

Parameters 

• $tax_query – array of filtering by taxonomies
• $terms – values of the current attribute
• $taxonomy_data – parameters for recounting the number of products for attribute values
• $old_tax_query – current array $tax_query

An array of filtering using meta_query product meta data, which is applied in the request for recounting product quantity for attribute values.

Parameters 

• $meta_query – array of filtering with metadata
• $terms – values of the current attribute
• $taxonomy_data – parameters for recounting the number of products for attribute values
• $old_meta_query – current array $meta_query

Filtering of arguments that are passed to the get_terms function in WordPress; obtaining attribute values for filters.

Parameters 

• $args – arguments for get_terms
• $additional – additional parameters that are used for further value filtering

Filtering of additional parameters to get the correct values of attributes; obtaining attribute values for filters.

Parameters 

• $additional – additional parameters that are used for further value filtering
• $args – arguments for get_terms

Filtering of the obtained attribute values.

Parameters

• $terms – attribute values from the get_terms function
• $args – arguments for get_terms
• $additional – additional parameters that are used for further value filtering

Generation of HTML code of an element by a filter builder.

The plugin defines 2 types of element{$type} tag and tag_open.

Parameters 

• $html – HTML code, empty string; must be generated with this hook
• $element – all element parameters

Filtering of the list of widget types on the page of creating filters.

Parameters

• $widget_types – array with data of all types of widgets

Filtering of price range.

Parameters 

• $price_range – array of two minimum price and maximum price values

Filtering of array with request elements to count the number of products in a price range.

Parameters 

• $query_args – array from which the request is collected

Changes the name of additional attributes for use in title, header, description blocks of the page.

Parameters

• $taxonomy_label – attribute name
• $term_parsed – array of data about the value of an attribute (may differ depending on the filter type)
• $custom_name – array with all available additional attributes

Changes the value name of additional attributes for use in title, header, description blocks of the page.

Parameters 

• $term_name – value name of attribute 
• $term_parsed – array of data about the value of an attribute (may differ depending on the filter type)

A boolean that specifies whether there are filters on the page or not.

Parameters

• $filters [boolean] – check regular filters
• $limits [boolean] – check sliders with attributes
• $price [boolean] – check price slider
• $search [boolean] – check your search

Returns

[boolean] A boolean that specifies whether there are filters or not.

A boolean that specifies whether attribute value is selected or not for a checkbox, radio button or drop-down list.

Parameters 

• $term [object] – WP_Term object with the value of the attribute to be checked
• $checked [boolean] – for checkbox, radio button
• $child_parent [boolean] – search in children
• $depth [int] – search directory tree 

Returns

[string] A string with text for a checkbox, radio button or drop-down list.

Returns values selected in filters for taxonomy.

Parameters 

• $taxonomy [string] – taxonomy slug 

Returns

[array] An array with the ID of taxonomy values.

Adding filtering to an array to be used for WP_Query

Parameters 

• $query_vars [array] – array with current parameters

Returns

[array] An array with parameters collected from an incoming array and data for filtering.

Since version 3.0 (1.5 for the free version) the plugin uses functions similar to the hooks in WordPress for JavaScript code.

Find more information about all JavaScript hooks on this page. Find more information on the functions for applying filters on this page.

When adding a hook straight away on page load, you need to check whether the functions are available. If they are not available use the berocket_hooks_ready event, which is called immediately after initializing functions.

Example code for replacing the function of unfolding filters:

bapf_custom_smb_open_function = function(use_default, $this) {
    $this.find('.bapf_body').first().show();
    if( $this.find('.bapf_colaps_smb').length ) {
        $this.find('.bapf_colaps_smb').removeClass('fa-chevron-down').addClass('fa-chevron-up');
    }
    return false;
}
if ( typeof(berocket_add_filter) == 'function' ) {
    berocket_add_filter('colaps_smb_open_apply', bapf_custom_smb_open_function);
} else {
    jQuery(document).on('berocket_hooks_ready', function() {
        berocket_add_filter('colaps_smb_open_apply', bapf_custom_smb_open_function);
    });
}

Functions can be called in custom scripts.

berocket_add_filter

berocket_apply_filters

berocket_do_action

berocket_remove_filter

berocket_throw_error

braapf_init_load

braapf_update_products

braapf_grab_all

braapf_grab_single

braapf_compact_filters

braapf_compat_filters_to_string

braapf_get_current_url_data

braapf_build_url_from_urldata

braapf_filter_products_by_url

Starting with version 3.0, JavaScript code of the plugin has an analogue of WordPress hook to change the behavior of filters.

All functions are analogs of WordPress functions.

Functions that are applied for hooks and WordPress analogs:

berocket_add_filter – add_filter

berocket_apply_filters – apply_filters

berocket_do_action – do_action

berocket_remove_filter – remove_filter

input_ckbox_changed

filter_changed_element

ajax_load_from_pagination

braapf_filters_mask

before_update_products_context

apply_filters_to_page

apply_filters_to_page_partial

ajax_load_from_filters_partial

page_has_products_holder

ajax_load_from_filters

grab_all_filters

grab_single_filter_taxonomy_undefined

grab_single_filter_exist

grab_single_filter

grab_single_filter_default

glue_by_operator

compat_filters_result_single

compat_filters_result

compat_filters_to_string_single

compat_filters_to_string

get_current_url_data

url_from_urldata_baselink

url_from_urldata_linkget

build_url_parameters_default

load_products_ajax_on_popstate

ajax_load_from_url_url

ajax_load_from_url_data

ajax_load_from_url_callback

ajax_load_from_url_beforeSend

ajax_load_from_url_done

ajax_load_from_url_done_after

ajax_load_from_url_fail

ajax_load_from_url_fail_after

ajax_load_from_url_always

ajax_load_from_url_always_after

jqrui_data_slidr_ion

jqrui_slidr_ion_{data-display}

jqrui_slidr_ion_link_{data-display}

jqrui_slidr_{data-display}

jqrui_slidr_link_{data-display}

hidden_clickable_close_mouseleave

hidden_clickable_open_delay

bapf_rst_nofltr_hide

bapf_rst_sel_show

pagination_links_a_tags

pagination_href_from_clicked_a

filter_mobile_width

filter_tablet_width

remove_same_filters_to_prevent_errors

update_page_on_error

default_selected_filters_area_single

default_selected_filters_area_full_exist

default_selected_filters_area_full_notexist

remove_shortcode_fix_filters

scroll_shop_to_top

universal_theme_compatibility

uncode_theme_compatibility

flatsome_theme_compatibility

woodmart_theme_compatibility

divi_theme_compatibility

rey_theme_compatibility

layzyloadimage_script_compatibility

jetpacklazyimages_script_compatibility

braapf_init_filtered_set

update_products

braapf_init

braapf_init_for_parent