Contributions welcome on GitHub! https://github.com/jchristopher/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.
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
SearchWP Live Ajax Search ships with a Widget allowing you to insert live search forms wherever you’d like.
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
inputyou want to hook:
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
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
templatesfolder 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-searchin your theme directory and copy
search-results.phpinto 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
defaultvalues to whatever you want.
Contributors & Developers
“SearchWP Live Ajax Search” is open source software. The following people have contributed to this plugin.Contributors
- Fixes the translations of the plugin.
- Adds new Settings admin page to control the behavior of the plugin easier.
- Introduces significant code refactoring to improve performance.
- Improves sanitization of the ‘swpengine’ search field argument.
- Standardizes direct access restrictions in classes throughout the plugin.
- Limits the arguments passed to the query when used with the WordPress native search.
- Fixes PHP Notice introduced in 1.6.0
- Adds support search form block in block editor (Gutenberg)
- Adds support for post_status, post_type, and posts_per_page query vars when not using SearchWP
- Updates translation source, updates translations with fixed textdomain
- Refactored bundle process
- Updates bundle dependencies
- Adds compatibility for SearchWP 4
- Fixes an issue with quoted phrase support
- Fixes an issue with post types that are excluded from search when registered (applies only to searches with SearchWP)
- Fixes an issue with bundle.js in some cases
- Improves SearchWP compatibility by suppressing filters when SearchWP performs the search
- Compatibility fix with SearchWP Modal Search Form
- Fixes an issue that may have prevented spinner customizations from being applied correctly
- Removes post type from default results template
- Fixes an issue with HTML entities in search string
- Updates translation source and translations
- Updates bundler build process
- Updates a11y where applicable
- Automatically cancels pending searches when search input is changed
- Fixes typo in results template function call
- Many a11y improvements (props @geoffreycrofte)
- Adds message when minimum characters have not been reached
- Added German translation (props @stefan-meier)
- Added Polish translation (props @boguslawski-piotr)
- Added Dutch translation (props Stefan G.)
- Updated translation source
- Reworked build process to be more straightforward
- Support script debugging (props mgratch)
- Remove form action requirement to better integrate with other code (props mgratch)
- Fixed an issue that prevented search from firing when re-entered too fast (props pierrestoffe)
- Added configuration option to prevent AJAX cancellation when Enter key is pressed
- Added some actions to make customization easier
- Added filter to customize location of results template
- Fixed an issue with missing engine name
- Fixed an issue that prevented multiple live search instances on a single page from using different engines
- Fixed an issue where
results_destroy_on_blurwas not properly applied if a custom configuration was used but that property was not defined in the custom configuration
- No longer limit results to built in post types
results_destroy_on_blurconfig option to prevent automatic removal of results window when clicking outside results pane
- Fixed an issue that prevented SearchWP Supplemental engines from showing up in the Widget config
- Added French translation
- Added Serbian translation
- Define default post statuses when using WordPress native search
- New filter
searchwp_live_search_query_argsto manipulate query args before searches
- Fixed an offset when positioning results on top of the search field
- PHP Warning cleanup
- New action:
- Adds Relevanssi support (based on Dave’s WordPress Live Search’s implementation)
- Corrected the default results template folder name to be
searchwp-live-ajax-searchas is in the documentation
- Improvement: hide the results box when query is emptied (props Lennard Voogdt)
- Fixed an issue with Media not showing in results when integrated with SearchWP
- Fixed an issue where a false set of no results would be returned (props Lennard Voogdt)
- Resolved an issue where hitting Enter/Return prevented the search query from being passed to the results page
- Fixed potential false positive for DOING_AJAX (props justinsainton)
- Removed unnecessary call to get_the_ID() in the default results template (props justinsainton)
- Added escaping to permalink and post type name in the default results template (props justinsainton)
- Utilize a WordPress core translated string instead of a custom one (props justinsainton)
- Increase the priority for the get_search_form filter so as to accommodate existing filters
- Added Serbo-Croatian translation (props Andrijana Nikolic)
- Fixed a directory URL issue
- Initial release!