Plugin Documentation

Configuring the Search in Place plugin in details.

How it works?

Search in Place is a WordPress plugin that improves the website's search experience, applying to the search boxes of website the search in place behavior. The plugin searches in background and real time those posts and pages that include the terms typed by the users, satisying their needs immediately:

Search in Place pop-up

The search boxes can be configured to search in the current page's content, highlighting the search terms.

Search in page

Installation

To install the WordPress plugin follow these steps:

  1. Download the plugin to your computer.
  2. Go to the plugins section in WordPress
  3. If has been installed another version of the plugin, deactivate it, and then press the corresponding "Delete" button.
  4. Press the "Add New" button at top of section.
  5. Press the "Upload Plugin" button, and select the zipped file downloaded in the first step.
  6. Finally, install and activate the plugin.

Uninstalling

To uninstall the plugin, deleting first all its settings:

  1. Go to the settings page of the plugin, through the "Search in Place" menu option.
  2. Tick the "Delete all settings?" checkbox, and then, press the "Update Settings"
  3. Finally, go to the plugins section to deactivate and delete the plugin.

Uninstalling

Registering the plugin

Search in Place Register Section

Register the copy of the plugin is required to receive the plugin's updates directly on WordPress

To register the copy of the plugin:

  1. Go to the settings page of the plugin, through the "Search in Place" menu option.
  2. Enter exactly the same email address used to purchase the plugin, into the input box: "Enter the email address of buyer"
  3. And then, press the "Register" button

Setting Up the Search in Place

The settings page of the plugin is accessible through the menu option: "Search in Place". The settings page of the plugin allows to configure where to search, which information to take into account, and define the appearance of the results pop-up and the search results page.

Configuring the search in place behavior

The plugin applies the search in place behavior to every search box on website by default. However, it is possible configure the plugin to apply the search in place behavior only to those search boxes inserted by the plugin shortcode ([search-in-place-form])

To do this, tick the "Apply to the search box inserted as shortcode only" checkbox.

Apply the Search in Place to

Another very important step in the configuration process allows to decide: The number of items to include in the results popup, the minimum length of search terms for triggeing the search in background, the post types to search....

Configuring the basic search process

Enter the number of posts to display: limits the number of elements in the dynamic search results. (Enter a whole number).

Enter a minimum number of characters to start a search: The dynamic search will be activated only when the entered search term equals or exceeds the number of characters specified in this setup field.

Connection operator: Selects the operator to apply to the search terms.

Posts/Pages common data (title, content): Allows to decide if search the terms into posts' titles and contents.

Posts/Pages metadata (additional data of articles): Allows to search the terms in metadata associated to the articles.

Search by Post Types

The plugin searches by the common WordPress post types (pages and posts) by default, however it is possible configure the plugin to include in the search process custom post types, like WooCommerce products, downloads of Easy Digital Downloads, and any other custom post type.

Configuring the post types to include in the search process

Every post type has associated a pair of input box: for the post type name, and its label. The name box corresponds to the post type name (for example, post type name of songs in the Music Store plugin is "ms_song"). The text entered into the label box would be used for labeling the search results in the po-up, and search results page.

This section includes some buttons, that works like shortcuts to include the post types of popular plugins (WooCommerce, WP e-Commerce, etc.)

Search by taxonomies

Our plugin allows to extend the search process not only to the posts information, it is possible to search by the taxonomies associated to the posts too. The categories are taxonomies, like the tags associated to the posts, and many other taxonomies defined by third party plugins.

Similar to the post types section, the plugin allows to enter the taxonomies to consider in the search process.

Configuring the taxonomies to include in the search process

Excluding posts/pages from search results

The plugin searches by all posts and pages, whose post types were defined previously, but it is possible to exclude some of them. Every post/page has associated an id. To exclude some post/pages from the search process, simply enter their ids separated by comma symbols, through the attribute: "Exclude posts/pages (Ids separated by comma)"

Excluding pages and posts from search results

Configuring the appearance of results pop-up (elements and design)

There are thousands of available WordPress themes, with their own designs and colors. This situation makes essential the possibility to modify the appearance of results pop-up, from the own plugin's settings.

Pop-up Appearance

Elements to display: defines the elements that will be shown for every resulting post. The post title will always be visible, but the featured image, the author, the publication date, and the post summary can be configured as visible or not, depending on this setting option.

Select the Date Format: allows to select the format of publication date to be shown in the results pop-up.

Enter the number of characters for post summaries: if you choose to display post summaries in search results, this option allows to limit its length.

Background color: background color of results pop-up.

Border color: border color of results pop-up.

Label text color: text color of post types labels.

Label background color: background color of labels section. The label's sections is a gradient.

Background color of active item: background color of item on hover condition.

Configuring the appearance of results pages

The plugin allows to highlight the search terms in the search results page, and the resulting pages. Furthermore, it is possible to display the labels associated to the posts types in the search results page.

Results Pages Appearance

Suggesting Terms

Reduce the users friction when interact with an interface is essencial in the software development. For this reason, the search in place plugin includes a section in its settings, to integrate "Google Autocomplete" in the search boxes. The autocomplete works as follows: as the users type the search terms, the autocomplete feature suggest new related terms, by pressing the space bar the suggested terms become in search terms, improving the search experience.

Google Autocomplete

Search in Place shortcode for inserting additional search boxes

The plugin applies the search in place behavior to every search box on website. This not requires any user action. However, it is possible to insert additional search boxes using the search shorcode (for example, if you need to search in current page only)

The shortcode to insert additional search boxes has the structure: [search-in-place-form]

Including the in_current_page attribute into the shortcode, it is possible to restrict the search to the content of current page only: [search-in-place-form in_current_page="1"]

To define the placeholder text in the search box, includes the placeholder attribute in the shortcode: [search-in-place-form placeholder="your text here"]

The plugin allows you to insert a search box to search for specific post types, regardless of the post types entered through the settigns page of the plugin, by adding the post_types attribute in the shortcode, and separating the post types by comma: [search-in-place-form post_types="product,download"]

Inserting the Shortcode from different Pages Builders

The plugin is distributed with specific modules for inserting the shortcode with the most popular pages builders.

Gutenberg Editor

Gutenberg Editor

Elementor

Elementor

Siteorigin Page Builer

Siteorigin Page Builer

For other pages builders it is possible to insert the shortcode directly.