“WooCommerce Search Box” Documentation by “Guaven Labs” v2.0.3


“WooCommerce Search Box”

Updated: 18/08/2018
By: Guaven Labs
Email: [email protected]

Thank you for purchasing this plugin. If you have any questions that are beyond the scope of this help file, please feel free to email via my user page contact form here. Thanks!


Table of Contents

  1. Short introduction
  2. Installation and activation
  3. Quick&simple usage guide
  4. Build the cache
  5. Initial text messages
  6. Featured products block
  7. Recently viewed products block
  8. Trending products block
  9. The most popular products block after "no match" message
  10. Search by category names block
  11. Automatic typo resolver
  12. Advanced settings: Layout, custom CSS
  13. Using with WPML (If your website is using WPML)
  14. Important notes
  15. Backend Search
  16. Smart Price Expressions
  17. Search Analytics
  18. Sample configure and the result test: Video Help

Short introduction - top

WooCommerce Search Box is a very powerful and easy to use plugin which turns a simple search box of your Woo Store to the powerful multifunctional magic box which can help you to sell more products. The plugin has 7 main features:
  1. Cached and very fast search product/category/taxonomy suggestions - no any ajax or server-side loading, so it is really fast.
  2. Featured/pinned products and categories block in live search suggestions box
  3. Trending products block in live search suggestions box
  4. Recently visited products block in live search suggestions box which is visitor individual.
  5. Backend search feature, which forces your theme to show same smart search results with live search box
  6. Search Analytics
  7. Additional help messages such as "type any text you want: f.e. child shoes", "no any match found" in search suggestions box

Installation and activation - top

  1. Unzip downloaded zip and copy woo-search-box.zip to your wp-content/plugins directory.
  2. Unzip it.
  3. Go to Dashboard/Plugins and Activate the plugin.
  4. Go to “Dashboard/WooCommerce/Search Engine" to configure the plugin.
Menu item

Quick&simple usage guide - top

If you just like to make the plugin working, without any configuration, then just follow these steps:

Quick Usage #1

  1. Click to "Rebuild the cache"

And that's all. Live search suggestion box would start working based on main product data.

Quick Usage #2

  1. Go do "Data Building" tab.
  2. Choose some attributes from the given "Search by more data" list.
  3. Go to "Backend Search" tab, and choose 2nd or 3rd option.
  4. Save the settings
  5. Click to "Rebuild the cache"

And that's all. Live search suggestion box would start working based on main product data + their attributes, taxonomies. And your theme's backend search results would start showing same smart search results


Build the first cached search data - top

After you opened “Dashboard/WooCommerce/Search Engine" admin page the default settings will be configured automatically. So just click "Rebuild the Cache" to build your first cached data

Rebuild button

After it is done you will see green message box below the button

Rebuild button result

If you don't get the message above and instead of it you get

"Your plugins folder is not writable by the system. That's why generated js data will be printed in your html code, not in separated js file.(it works in both cases, so don't worry) If you want to held js data separately, just make your plugins folder writable and then Rebuild the Cache again."
then don't worry, the plugin will still work. It just means that your filesystem doesn't allow to create cached js data. So the plugin will use db cache instead of js cache.

Automatize cache building process
You can also automatize cache building process with simple schedule. To use this feature just go to "Data Building" tab

Rebuild automatization

With this setting you can set autorebuilding after each product edit.(after you edit and save any change in any product, cache will be auto-built immeditially.) With this setting you can also put rebuild button to wp-admin top bar.


Initial texts - top

Initial texts are 2 strings which appears when
1. When user clicks(focuses) on input field for searching something - first string appears (any help message such as: Type any product name you want, f.e. child shoes, blue jeans etc.)

Rebuild button result

2. When user types some string and there is not any related product - second string appears (any notfound message such as: No any matches)

Rebuild button result

To enable/disable and configure these messages you can use the first row in plugin's admin page

Rebuild button result


This feature adds a little products block to the search suggestion bar which displays visitors' latest visited producst.

Rebuild button result

To enable/disable and configure these messages you can use the second row in plugin's admin page

Rebuild button result

You see "Pinned product ID numbers" there. To get products' ID numbers is easy. Just go Dashboard/WooCommerce/Products and hover any product you want, you will see ID number there.
For example ID number of this product is 19811

Rebuild button result


"Recently viewed products for users" block - top

This feature adds a small products block to the search suggestion bar which displays visitors' latest visited products.

Rebuild button result

To enable/disable and configure these messages you can use the third row in plugin's admin page

Rebuild button result

This feature adds a small products block to the search suggestion bar which displays trending products of your webstore.

Rebuild button result


The most popular products block after "no match" message - top

This feature adds a little products block to the search suggestion bar which displays visitors' latest visited producst.

Rebuild button result

To enable/disable and configure these messages you can use the fourth row in plugin's admin page


Search by category/taxonomy names block - top

This feature adds search by category/taxonomy names to search suggestion bar.

Rebuild button result

To enable/disable and configure these messages you can use the fifth row in plugin's admin page


Automatic typo resolver - top

If you enable this feature, the plugin will automatically recognize visitor's typo mistake inputs and will show relevant products.

Rebuild button result

To enable/disable and configure these messages you can use the fourth row in plugin's admin page

Rebuild button result

Advanced settings: Layout, custom CSS, Exclude categories, Search by tags and attributes, Synonym list, Narrowed Search - top

If you have experience about layout html template and css, you can customize suggestion box UI. The needed classes names are given below the custom css textarea.
You don't have such experience, just skip this feature.

Here is sample image which shows correctly filled advanced settings:

Rebuild button result


Plugin strings with WPML - top

Building Cache:
You need to build the cache for each language. Just open the plugin's settings page, choose language from wp-admin top-bar, and click to "rebuild the cache" button.

Translations:

If you are using WPML, you will need the translation of strings(initial texts and block titles)

We have created simple method for this. Just use easy XML texts and our plugin will get the needed text from XML. Here is how

For example your website has 2 languages: English and German. So you want to show "No product found by your keyword" in english, "Kein Produkt von Ihrem Stichwort gefunden" in german versions. Just use such XML data to solve this:

<wpml><en>No product found by your keyword</en><de>Kein Produkt von Ihrem Stichwort gefunden</de></wpml>
That's all.

Rebuild button result


Backend Search - top

This feature works on cookie based algorithm. When user types something and sees live results, our system keeps result set and then uses it at backend side. That's why backend search results becomes smart and magic, similar to front live suggestions. Just check its checkbox and save settings and it will be enabled.

Rebuild button result


Smart Price Expressions - top

Here is filled fields as an example. After filling the given fields you will get working smart expressions, such as: 100$ smartphone, $100 smartphone, smartphones around 150$, smartphones under 500 usd etc.

Smart Price Expressions


Analytics - top

To enable analytics click to ANALYTICS button at the right side. Then enable it.

Search Analytics


Important notes - top



Once again, thank you so much for purchasing this plugin. I'd be glad to help you if you have any questions relating to this plugin. If you have a more general question relating to the plugins on Codecanyon, you might consider visiting the forums and asking your question in the "Item Discussion" section.

Guaven Labs

Go To Table of Contents