About searchwp-live-ajax-search

SearchWP Live Ajax Search is a WordPress plugin that enhances search forms with AJAX-powered live search functionality. Designed primarily for developers, it delivers a flexible, template-based results system that integrates seamlessly with any WordPress theme. While the plugin works optimally with the SearchWP engine to leverage advanced search algorithms, it is fully functional even if SearchWP is not installed. The core activation method involves adding a single HTML5 data attribute to search input fields, or it automatically applies to forms generated via the standard getsearchform() function. A dedicated widget is included to easily insert live search fields into sidebars or other layout areas. The plugin eschews complex option panels in favor of a template loader approach, allowing users to customize result layouts by editing standard theme template files. This architecture ensures the tool remains unobtrusive while offering deep customization capabilities for those who need to tweak behavior or design.

j

Published by

jchristopher

Visit View Profile

README.md

View on GitHub

SearchWP Live Ajax Search

SearchWP Live Ajax Search enables AJAX powered live search for your search forms.

Designed to be a developer's best friend, SearchWP Live Ajax Search aims to stay out of your way but at the same time allowing you to customize everything about it. It's set up to work with any WordPress theme and uses a template loader to display results. The template based approach allows you to seamlessly customize your SearchWP Live Search implementation without messing with dozens of cluttered options.

Works best with SearchWP (but SearchWP is not necessary)

SearchWP Live Ajax Search is best utilized in conjunction with SearchWP, but it is not required. If SearchWP is installed and activated, SearchWP Live Ajax Search can be customized to use any of your search engines per search form.

Customization

You can customize the implementation of SearchWP Live Ajax Search to a great degree, including any number of developer-defined configurations. The results are based on a template loader, allowing SearchWP Live Ajax Search to stay out of your way and letting you write the results template as you would any other WordPress theme file.

Everything is powered by adding a single HTML5 data attribute (data-swplive="true") to the input field of your search form. This happens automagically out of the box for any search forms generated from get_search_form().

Widget support

SearchWP Live Ajax Search ships with a Widget allowing you to insert live search forms wherever you'd like.

Installation and Activation

Download the plugin and extract the files
Upload searchwp-live-search to your ~/wp-content/plugins/ directory
Activate the plugin through the 'Plugins' menu in WordPress
Optionally customize the configuration: full documentation
Optionally customize the results template: full documentation

Developer notes

Please see the documentation to read more about the plugin.

There is a build process for all JavaScript bundles contained within a single command:

npm run watch

This will execute all necessary processes that watch for file changes and subsequently generate all necessary code bundles.

searchwp-live-ajax-search