README.md

WDS React Post Search

Power up the basic WordPress search with React. This plugin taps into the WP REST API and uses React to power a real-time search of posts.

How does it work?

This taps into the search-form class (or whatever class you filter to above) to display results when you begin typing in any search input matching that same class.

Options

Search more than just posts

By default, the plugin will search only posts. However, you can use a filter like this to provide access to multiple post types. Your posts types must have show_in_rest set to true when registering your post type.

function _s_filter_post_types_to_query() {
    return array(
        'post_type_slug',
        'page',
    );
}
add_filter( 'wds_react_post_search_filter_post_types', '_s_filter_post_types_to_query' );

Filter the search messages

By default, we're displaying text like Loading... when results are loading, No results found. when no results are found, and Please enter at least 3 characters. when attempting to search with too few characters. These can all be filtered from your theme!

function _s_filter_search_loading_text() {
    return esc_html( 'Give us a second – results are loading!', '_s' );
}
add_filter( 'wds_react_post_search_loading_text', '_s_filter_search_loading_text' );

function _s_filter_search_no_results_text() {
    return esc_html( 'There are no results here, buddy.', '_s' );
}
add_filter( 'wds_react_post_search_no_results_text', '_s_filter_search_no_results_text' );

function _s_filter_search_length_error_text() {
    return esc_html( 'You need more characters!', '_s' );
}
add_filter( 'wds_react_post_search_length_error_text', '_s_filter_search_length_error_text' );

Change the minimum character limit?

There's a filter for that too. If you want the search to start working as soon as you start typing, just set your value to 0 or 1. Otherwise, you can set this to whatever number you wish. Remember, this is character count and not letter count – spaces count!

function _s_filter_search_minimum_character_count() {
	return 0;
}
add_filter( 'wds_react_post_search_minimum_character_count', '_s_filter_search_minimum_character_count' );

Does your search form use a different class? No problem!

By default, the plugin will target search-form as is set in the localize_script call:

'search_form_class' => apply_filters( 'wds_react_post_search_search_form_class', esc_attr( 'search-form' ) )

However, this can also be filtered if your search form uses another class or you want to target a specific instance of a form on a page:

function _s_filter_search_search_form_class() {
	return esc_attr( 'some-other-class' );
}
add_filter( 'wds_react_post_search_search_form_class', '_s_filter_search_search_form_class' );

Local Development

Clone this repo

git clone git@github.com:WebDevStudios/WDS-React-Post-Search.git

Change directories

cd WDS-React-Post-Search

Install NPM modules

npm i

Kick off development server

npm run start

Build production ready assets

npm run build

Note

WordPress wont recognize any plugins whose folder is Camel-Case. You'll need to rename this folder to: wds-react-post-search