devot:eeDevoted to ExpressionEngine

Display search results from your Google Custom Search Engine using standard EE template tags via the Google Custom Search JSON/Atom API.

Who’s it for?

This module is a great search solution for your site if:

• you have a low-to-medium traffic site;
• you want better relevance when searching, including the ability to add synonyms for search terms and more;
• you need to include the contents of PDF files in your search results;
• you need to search non-EE content (e.g., static HTML files) or content from other domains or sites, in addition to your EE content;

The Google Custom Search API currently limits searches to 100 results per query, and 100 free queries per day. There is no daily query limit if you enable billing on your account (additional queries are $5 per 1000 queries, per day.)

Google Custom Search also integrates with Snaptcha to prevent spam searches from using up your queries and filling your search log with junk. (A simpler, but less-ruthless “honeypot” anti-spam measure is included for those who don’t use Snaptcha.)

Requirements

 
• A Google Custom Search Engine ID or Linked Custom Search Engine file
 
• A Google Custom Search API key
 
• cURL and OpenSSL support on your server

Documentation

Google Custom Search includes complete documentation in the module control panel.

Change Log

• 1.1.3 - Added integration with Snaptcha; added new “snaptcha” and “snaptcha_level” parameters to the “form” tag; added compatibility with EE 2.6’s Localize class
• 1.1.2 - Added the {absolute_result_count} variable; added XID hash-checking to search form; fixed bug where you would not be redirected to Google for your search after hitting your daily API limit
• 1.1.1 - Fixed pagination bug when ordering/sorting by different fields in the search log
• 1.1.0 - Added {image} and {thumbnail_image} variables for results which include image metadata; added a slew of new parameters to catch up with the updated version of the Custom Search API; now using partial fields in the API call to speed up requests; fix for issues with IPv6 on some servers; pagination fix in control panel under MSM; added ability to sort the search log by keyword, search count, or date; added ability delete terms from the search log
• 1.0.11 - Fix for compatibility with EE 2.5+ on PHP < 5.2
• 1.0.10 - Fix for results pagination numbering
• 1.0.9 - Fix for PHP errors when returned results have no titles or summaries
• 1.0.8 - Added new (optional) “honeypot” parameter to the search form to trap search spam
• 1.0.7 - Added new variables: {current_page}, {total_pages}, {current_results_start}, and {current_results_end}
• 1.0.6 - Added more useful error messages when the API call fails
• 1.0.5 (the Marcus Neto edition) - Fixed issues with servers running PHP < 5.2 where the supplemental JSON library was not loading; added some template debugger messages
• 1.0.4 - Fixed potential issue with loading control panel view files
• 1.0.3 - Changed default results language from English to any language
• 1.0.2 - Now using md5 hashes for keyword segments instead of base64 encoding due to potential issues with equals (=) characters in the URL
• 1.0.1 - Added {format} variable, removed {is_pdf} variable
• 1.0 - Initial release

Support

Questions or issues? Please post on the officially-supported devot:ee forums.

This entry was created June 22, 2011, 11:20 am.
This entry was last updated April 19, 2013, 11:26 am.

Disclaimer: Information about ExpressionEngine add-ons is provided as a service to you, the user, and every member of the ExpressionEngine community. devot:ee is not responsible if you hose, mangle, wreck, or otherwise destroy your EE website by installing an add-on that you found out about at this site, regardless of its rating, Favorites status, commercial or free status, or general popularity. Caveat EEmptor!