wsa-helpcenter-white

SpeedSearch User Guide

Initial setup #

  1. After installing and activating the plugin, you can find it in the “WooCommerce” menu:

  2. After you open the plugin page, you will see plugin activation screen:
  3. Enter your license key and press “Activate”;
  4. Then you will see plugin Authorization screen:

  5. Press “Auth” button, and you will be redirect to authorization screen:
  6. Press the “Approve” button, and then you will be redirected to the plugin settings page.
  7. Follow the wizard for further guidance. 

Note: the plugin will start working (replacing WC page with SpeedSearch page) as soon as the synchronization is finished. Alternatively, you can check the setting “Replace WC store with SpeedSearch regardless of synchronization status (do not wait for synchronization to finish)” option on the “Misc” tab. This will 

Blocks #

Shortcodes #

 

Syntax example Description
[speedsearch hide_search=”0″] Main block – container holding all the sections rendered by the plugin.

Attributes:

hide_search – Whether to hide the search bar. Default: 0.

[speedsearch_search small_size=”1″ align=”center” search_in_results=”0″] Search block – contains the search bar only.

Attributes:

small_size – Whether the search bar size is small or not. Default: 0.

align – Alignment. Default: right. search_in_results – Whether to search in results. Default: 0.

[speedsearch_part_categories] Categories block – contains the list of all categories, with their children (subcategories).

No attributes.

[speedsearch_part_filters] Filters Block – contains all the available filters as selected from the WP settings, including Toggles (because toggles are filters).

No attributes.

[speedsearch_part_tags] Tags block – contains all the available tags as selected from the WP settings.

No attributes.

[speedsearch_part_posts] Posts block – contains the list of products. Will display a message when the search or filters applied do not yield any results. 

No attributes.

[speedsearch_part_filter name=”price”] Single “Price” filter – to be used when wanting to separate other filters from the price one.

No attributes.

[speedsearch_part_active_filters] Active filters block – displays all currently applied filters.

No attributes.

[speedsearch_part_toggle name=”reviews_allowed”] Single toggle. 

To get the toggle name, hover over it in the admin menu and wait for 2 seconds (“title” attribute). For example, the toggle “Reviews Allowed” will be “reviews_allowed”. 

Important: If the toggle is not active (in general or at least for one filter), it will not be shown.

No attributes.

[speedsearch_recently_viewed_products show_limit=”3″] List of recently viewed products. 

Attributes:

show_limit – The maximum number of recently viewed products to show. Can’t be more than 10.

 

  • Each shortcode supports html_id attribute, which adds ID to the HTML element. Syntax example: [speedsearch html_id=”speedsearch-main-block”]

Settings Import / Export #

Settings can be exported and imported when store owners wish to try out new configurations without loosing the current setup. Store owners can therefore export their settings, make the changes they wish to make and revert back to the old setup simply by importing back the settings.

Settings Export #

 

  1. Click on “Export Settings” button at the bottom of plugin settings screen;
  2. Click “yes” or “no” depending if you want to bundle the images to the export file – when you answer no, the images will be downloaded by their URLs upon import; answer yes if the site is not reachable via the internet, or if you want to export the settings as a backup.
  3. Select location where to save settings.

 

Settings Import #

 

  1. Click on “Import Settings” button at the bottom of plugin settings screen;
  2. Select exported settings file;
  3. Wait while the settings are imported (you can close the page or popup if you want, the import happens in the background).

Filters / Toggles Reordering #

 

You can change the order of filters and toggles by using drag-and-drop functionality in the WP dashboard.

 

  1. Go to plugin settings page;
  2. Go to “filters” tab;
  3. Use drag-and-drop to reorder filters and toggles (just press the left mouse button on the filter or toggle you want to reorder, move the mouse to the position where you want the element to be, and then release the mouse button).
  4. Press the “Save” button.

How caching works #

 

If you open the “Cache” settings tab, you can see that two types of cache are present:

 

  1. Cache;
  2. Products HTML in Object Cache.

 

Let’s take a closer look at each of them:

 

  1. Cache – combines several types of cache:
    1. AJAX requests cache – basically, for CDNs (like Cloudflare) – works very simply by, instead of making AJAX requests, requesting the .js file that contains JSON. The file then, if CDN is configured to cache .js files, will be cached by it; also browsers can cache .js files.
      The cache flush is implemented by adding a different prefix to the “file” (i.e. AJAX request).
    2. IndexedDB cache – all SpeedSearch responses are cached by browsers in IndexedDB for the period of “cache flush interval” (setting) * 10. Stale cache check occurs after cache flush interval but the cache value is still available for up to x 10. For example: cache flush interval is 1 hour, the value is stored in browser cache for up to 10 hours, but after 1 hour another validation request is done (to make sure the cache wasn’t changed).
  2. Products HTML in Object Cache – Uses wp_cache_set() to save products HTML to cache. Works best when you have Persistent Object Caching configured and enabled (e.g. Redis Object Cache). The obvious benefit is that getting direct HTML from cache is dramatically faster than generating a new HTML by the product ID (getting product data from DB and then applying template functions).

 

“Flush all cache” button flushes the first block of cache (not Products HTML in Object Cache); If you want to flush products objects cache, use a separate button for it (“Flush all products HTML in Object Cache”).