“Search Manager” Documentation by “TeamDev” v1.0

---

“Search Manager — Plugin for WooCommerce and WordPress”

---

Table of Contents

1. Plugin Installation
2. Admin Interface
3. Plugin Widgets
4. Plugin Shortcodes
5. Plugin Filters and Actions
6. Frequently Asked Questions
7. Sources and Credits

---

A) Plugin Installation - top

From Your WordPress Dashboard

1. Visit 'Plugins > Add New'.
2. Click 'Upload Plugin'.
3. Select zip-archive with plugin and click 'Install Now'.
4. Activate Search Manager from your plugins page.

Via File Upload

1. Unpack zip-archive with plugin.
2. Upload the 'search-manager' folder to your '/wp-content/plugins/' directory, using your favorite method (ftp, sftp, etc...)
3. Activate Search Manager from your plugins page.

Once Activated

1. Visit 'Search Manager > Settings' and adjust the preferences.
2. Check your search works fine and enjoy plugin usage.

---

B) Admin Interface - top

Plugin Settings:

Here you can configure search settings for your needs.

Adding New Search Term (manually):

Here you can manually add new search term. Also plugin creates new search term record automatically when someone searches through the site. The same screen you see when you editing existing search term.

List of all Saved Search Terms:

Here you can see all your search terms on your site.

Reports Screen:

Here you can see and analyze stats on your site search usage.

Plugin Widgets:

Here you can add plugin widgets to your sidebars.

---

C) Plugin Widgets - top

Recent Search Terms Widget:

Search Terms Cloud Widget:

Popular Search Terms Widget:

---

D) Plugin Shortcodes - top

Search Manager plugin provides with three shortcodes for embedding into the post content.

Search Cloud Shortcode

[wcstm_search_cloud smallest=5 largest=10 cold='CCCCCC' hot='000000' number=5]

Parameters:

• smallest="..." - font size for elements with less search results (optional)
• largest="..." - font size for elements with more search results (optional)
• cold="..." - font color for elements with less search results (optional)
• hot="..." - font color for elements with more search results (optional)
• number="..." - number of elements that will be displayed (optional)

Popular Search Shortcode

[wcstm_popular_search title='Popular Search Terms' number=5]

Parameters:

• title="..." - title of Popular Search section (optional)
• number="..." - number of elements that will be displayed (optional)

Recent Search Shortcode

[wcstm_recent_search title='Recent Search Terms' number=5]

• title="..." - title of Recent Search section (optional)
• number="..." - number of elements that will be displayed (optional)

Search Form Shortcode

[wcstm_search_form]

Add wcps='1' parameter to the shortcode if you need to display WooCommerce search form.

---

E) Plugin Filters and Actions - top

Hooks in WordPress core, plugins and themes essentially allow you to manipulate code without editing core files. So you can change third-party plugin behaviour from your own theme or plugin and keep future updates as well.

Plugin Hooks

• wcstm_custom_periods_with_results - allows to add/update report section data with results (Example #4)
• wcstm_custom_periods_without_results - allows to add/update reports data section without results
• wcstm_redirect_type - allows changing of the redirection type (301, 302, 307, etc.) before redirect is processed

Reports Filter

Let's add custom statistical data to the report table:

add_filter('wcstm_custom_period_with_results', function($periods) {

    $periods['custom']['title'] = __('Custom period');
    $periods['custom']['start_date'] = '2016-01-02';
    $periods['custom']['end_date'] = '2016-01-05';

    return $periods;

});

---

F) Frequently Asked Questions - top

Can I use plugin without WooCommerce installed?

Yes, for sure.

Will autocomplete work if I have custom search form?

Yes, just setup correct CSS selector in autocomplete settings.

What is search term redirect?

This feature allows you to point user to correct page skipping search results. E.g. user searches for 'iphone 6s' and you redirect it to the appropriate page instead of showing search results by this query.

What is popular search terms?

This is a widget that shows list of most popular search queries on your site.

What if I need this plugin customised?

We can help you tuning the plugin up to your needs, or even creating a new one from scratch, per your requirements. Drop us your request and we will get back with the estimate shortly.

---

G) Sources and Credits - top

We've used the following javascript libraries as listed.

• Ajax Autocomplete for jQuery from Tomas Kirda.
• jQuery Validation Plugin from Jörn Zaefferer

Ajax Autocomplete for jQuery is freely distributable under the terms of an MIT-style license.

jQuery Validation Plugin licensed under the MIT license.

---

Once again, thank you so much for purchasing this plugin. We would be glad to help you if you have any questions relating to this plugin. No guarantees, but we'll do our best to assist. 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.

TeamDev

Go To Table of Contents

---