SearchWP Live Ajax Search

About this plugin

Questions

Documentation?

Of course! Full documentation

How do I add live search to my search form?

SearchWP Live Ajax Search will automatically enable itself on any search forms generated with get_search_form(). You can prevent that with the following filter:

add_filter( 'searchwp_live_search_hijack_get_search_form', '__return_false' );

If you would like to manually enable SearchWP Live Ajax Search on a custom search form, simply add the following data attribute to the input you want to hook: data-swplive="true"

How are search results generated?

By default, SearchWP Live Ajax Search uses the default SearchWP Search Engine if you are using SearchWP. If you don’t have SearchWP, native WordPress search results are provided. If you would like to customize which search engine SearchWP uses, simply add the following attribute to the form input: data-swpengine="supplemental" replacing ‘supplemental’ with your desired search engine name.

How do I customize the results template

SearchWP Live Ajax Search uses a template loader. In the plugin folder you will find a templates folder which includes search-results.php — that is what’s used out of the box to output search results. To customize that output, simply create a folder called searchwp-live-ajax-search in your theme directory and copy search-results.php into that folder. SearchWP Live Ajax Search will then use that file instead of the one that shipped with the plugin, and you can customize it as you would other theme template files.

SearchWP Live Ajax Search also outputs two sets of styles. The primary set of styles simply preps the results wrapper to be positioned properly. The second set of styles controls the visual appearance. This abstraction was made to ensure customization is as straighforward as possible. You can disable the default ‘theme’ by dequeueing the applicable stylesheet, and you can also disable the foundational CSS as well. More information available in the documentation.

How do I customize the spinner

SearchWP Live Ajax Search uses a filter — searchwp_live_search_configs — that allows you to fully customize the configuration used. Simply add a new key to the array passed through that filter, customizing the default values to whatever you want.