The Climate Search Plugin for WordPress is easy to install.
The plugin can be added to any page using its shortcode
[climatesearch]. You will find the preferences for the default behaviour of the plugin in Settings-Climate Search.
Additionally, Widgets can be used for a global use of the search on the website (i.e. Climate Search Input form field), as well as to suggest options for refined and related searches that are only shown on the results page.
Detailed Description and Use of the Plugin
- PHP Version: 5.3 or above.
- WordPress Version: 4.5 or above.
The plugin provides some options for basic settings to change its functionality as needed (Admin Panel > Settings > Climate Search). The options set will be used as the default options for the plugin (but can be changed per-page through the different attributes of the shortcodes).
The options provided are:
- Enable/Disable the Autocomplete feature for the form by default if no attributes are provided in shortcode.
- Enable/Disable Google Search Results by default if no attributes are provided in shortcode.
- Set default language if no language attribute is provided in shortcode.
- Set display result page (where the results should be displayed once the form is submitted).
- Disable the default style for the plugin display template and add the custom style file for custom design option. (Note: If the “Disable default style” is “checked” or enabled, the user has to provide the custom style path in the field provided, which should include the full style for the plugin result display section, i.e., all the styles provided by the plugin are excluded).
- Language Options, i.e. add the translated text for some specific section to manage translations for the language translation option.
- Import/Update for the concepts from the endpoint.
Using Plugins’ Shortcode
The plugin uses the shortcode [climatesearch] to render the output. Different attributes can be added in the plugin as:
- autocomplete=true/false: Setting the “autocomplete” value to “true” will enable the autocomplete feature for the form and “false” will disable the autocomplete. If the “autocomplete” attribute is not provided the option from the setting section will be used.
- googlesearch=true/false: Setting the “googlesearch” value to “true” will enable the Google Search Engine feature, rendering the list of related website specified. Google Search uses the Google Custom Search Engine Key (provided by Google) to perform the search work.
- lang=en/es/de/fr/pt: The lang attribute specifies the language that should render the results from “reegle” endpoint and Google Search Engine. English (en) is the default language used.
- langselectoronsubmit=true/false: This attribute will help to display the language selector section only if the climate search form is submitted. Default is “false”.
- langselector=true/false: This will enable/disable the language selector option. Default is “true”.
- formaction=”” : This attribute will display the results to the specific link provide (the specific page should use the [climatesearch] shortcode with optional attributes). If empty value is passed, the results will be displayed in same page. Default formaction will be added from option selected from plugins’ setting page.
- refinedsearch=true/false: This will enable/disable the feature to display the “refine search” terms. Default is “true”. (previously mentioned as “relatedterms”).
- relatedsearch=true/false: This will enable/disable the feature to display the “related search” terms. Default is true.
Using Plugins’ Widgets
The plugin provides the following widgets:
- Climate Search Form: This will display form for the climate search.
- Climate Search Refine Search: This will display the “refine search” if the terms are not empty after submitting the form. The shortcode attribute “refinedsearch=false” can be used to hide the “refine search” terms and use the widget to display the “refine search” in sidebar widget section.
- Climate Search Related Search: This will display the “related search” if the terms are not empty after submitting the form. The shortcode attribute “relatedsearch=false” can be used and use the widget to display the “related search” sidebar widget section.
The Plugin is licensed under GPLv2.