Back to top

YITH WooCommerce Ajax Search Documentation

Thank you so much for using our plugin.

YITH WooCommerce Ajax Search - Wordpress plugin

This document covers the installation and use of this plugin and reveals answers to common problems and issues - I encourage you to read this document if you are experiencing any difficulties.

Get started!


 

Getting started

To install this plugin you must have a working version of WordPress already installed. For information in regard to installing the WordPress platform, please see the WordPress Codex - http://codex.wordpress.org/Installing_WordPress

Installation

Upload via ftp:

First, unzip the zip archive you downloaded on your computer. Upload the folder to your server via ftp to the   /plugins/ directory on your Wordpress installation. (wp-content > plugins)

Upload via Wordpress admin:

Go to your Wordpress admin, and in the Plugins-panel, choose Add New. Click Upload in the below the title "Install Plugins". Upload the plugin zip.

Installing WordPress  http://codex.wordpress.org/Installing_WordPress

Activation

Once you have uploaded the plugin, activate your plugin in Plugins > Installed plugins.
This plugin will work only if WooCommerce - excelling eCommerce is installed and active.

Usage

The plugin can be used in 3 different ways:

  • as a widget. You just need to drag the YITH WooCommerce Ajax Search widget within the sidebar you want to use.
  • as a shortcode. You can put the shortcode [yith_woocommerce_ajax_search] within the page content.
  • within the code. You can place the following code in your templates:
    <?php echo do_shortcode('[yith_woocommerce_ajax_search]'); ?>

Settings

In WooCommerce > Settings > Ajax Search > tab you will find the settings of the plugin:

Settings

The screenshot above shows the default settings of the plugin.

General Settings
Search input label Label for Search input field.
Search submit label Label for Search submit field.
Minimum nunber of characters Minimum number of characters required to trigger autosuggest.
Maximum number of results Maximum number of results showed within the autosuggest box.

Codex

The plugin allows you to use your own custom templates and stylesheets.

Custom Stylesheet

In order to customize the style of the plugin you can easily create a file called yith_ajax_search.css within the woocommerce folder of your theme. The file will be automatically loaded from your theme instead of the plugin folder.

In this way the yith_wcas_ajax_search.css file contained within the plugin will be replaced with your stylesheet. Keep in mind to copy and paste the code contained within this file if you need that.

Custom Templates

If you need to include our plugin within your theme you can also customize the templates. Copy the file templates/yith-woocommerce-ajax-search.php from the plugin folder within the woocommerce folder of your theme and automatically the plugin will load the templates from your theme instead of the plugin folder.

FAQ

How can I change the minimum number of characters?

In WooCommerce->Settings->Ajax Search page, you can choose the minumum size of the search before to trigger autosuggest.

Localization

This plugin is ready for localization via .po/.mo files.

If you are not familiar with translating Wordpress plugins, I recommend you reading this article: http://codex.wordpress.org/Translating_WordPress

Change the language of YITH WooCommerce Zoom Magnifier Languages for dummies

  1. Check the values of your wp-config, the language of this file must match to your translation;
  2. Find the folder languages of the plugin
  3. Duplicate default.po
  4. Rename your copy of default.po example: yit-fr_FR.po for France, yit-en_EN.po for English, yit-he_HE.po for hebraic, and so on.
  5. Download POEdit
  6. Open your file with the POEdit software
  7. Update the catalog using the POT file (Catalog -> Update from POT file...)
  8. Translate your file (edit catalog properties using POEdit to add your credits)
  9. In File click on Preferences and tick Automatically generate mo
  10. Save your file
  11. Send the new .mo and .po via FTP to your server, in the folder languages of the plugin
  12. Send the new .mo and .po via email to plugins@yithemes.com so we can improve the quality of the plugin and you can help other users. We will thank you with official credits

Version 1.1.1 - Released: Feb, 13 - 2014

  1. Fixed: Settings link doesn't work on WooCommerce 2.1.1.

Version 1.1.0 - Released: Feb, 12 - 2014

  1. Added: Support to WooCommerce 2.1.x.

Version 1.0.0

  1. Initial release.