About this plugin
ATTN: This plugin only works with the PAID version of Google Custom Search.
With RDP Google Custom Search, you can target your site’s contents, or other site’s contents. You can add multiple CSEs and allow your visitor to choose one.
RDP Google Custom Search uses a simple shortcode so that a search box can be placed anywhere.
You can put a multi-CSE search box in the main content of your page, and then put another search box in the sidebar that is dedicated to only one CSE, such as your site.
Each search box also provides a Page selector, which will search the current page and highlight matching text.
The results are displayed using a special template that replaces the content of the current page/post and that can be styled as desired. The default width of the results content is 980px. The built-in rendering function marks up the results to use Google styling HTML and class names.
This plugin can be used with the RDP Wiki Embed plugin, which allows you to have the links in the search results that point to MediaWiki sites to postback and display content on your own web site.
Usage
RDP Google Custom Search is implemented using the shortcode [rdp-gcs]. It accepts the following arguments:
- id: (required) comma separated list of id numbers, indicating the CSEs to use
- default: when more than one CSE is selected, this indicates the CSE to use by default
Examples:
[rdp-gcs id=’3′]
[rdp-gcs id=’1,3′ default=’1′]
External Scripts Included
- jQuery.PositionCalculator v1.1.2 under MIT License
- jQuery Highlight under MIT License
PHP Hook Reference:
rdp_gcs_render_search_results_applied
- Params: none
- Fires after the default render function is added to the filters array.
rdp_gcs_styles_enqueued
- Params: none
- Fires after plugin-specific styles are enqueued
rdp_gcs_scripts_enqueued
- Params: none
- Fires after plugin-specific scripts are enqueued
PHP Filter Reference:
rdp_gcs_before_search_box
- Param: empty string
- Fires before the rendering of the search box within the results template
- Return: any text/HTML/script to be rendered before the search box
rdp_gcs_after_search_box
- Param: empty string
- Fires after the rendering of the search box within the results template
- Return: any text/HTML/script to be rendered after the search box
rdp_gcs_before_search_results
- Param: empty string
- Fires before the rendering of the search results within the results template
- Return: any text/HTML/script to be rendered before the search results
rdp_gcs_render_search_results
- Param 1: JSON object containing Google API search results or NULL if an error occurred during the API call
- Param 2: string containing the last error message set during the search request or empty string if no error occurred
- This filter is required for hooking into a function that will render the search results. For a custom rendering function, be sure to remove this filter during the rdp_gcs_render_search_results_applied hook, and then re-set this filter to use your custom rendering function
rdp_gcs_after_search_results
- Param: empty string
- Fires after the rendering of the search results within the results template
- Return: any text/HTML/script to be rendered after the search results