Highlights search terms using jQuery when referer is a search engine or within WordPress generated search results. This plugin is a light weight, low resource demanding and very simple fusion between How to Highlight Search Terms with jQuery – theme hack by Thaya Kareeson and Search Hilite by Ryan Boren, with some optimisations and updated to support HTML5.
- BuddyPress / bbPress compatibility: highlighting within forum searches
- Caching (WP Super Cache) compatibility
- Click through highlights: Highlights not only on WP search results page but also one click deeper inside any of the found pages
- Search terms wrapped in double qoutes now considered as single term
- Support for many more search engines: Google, Bing, Yahoo, Lycos, Ask, AOL, Baidu, Youdao, Dogpile, Search.com, Goodsearch.com, Mywebsearch.com, Webcrawler.com, Info.com
NOTE: to make the highlights visible in browsers that do not support HTML5 like Internet Explorer 8 or older you will have to define at least one CSS hilite styling! Read on below So what do I need to do? and Installation for more detailed instructions. You can find CSS examples in Other Notes.
What does it do?
This low impact plugin uses only two action hooks, wp_header where it needs to define some variables and wp_footer to insert the jQuery library (included in your WordPress package; only if not already loaded) and to add the hilite jQuery extension to your page source code. The jQuery extension that runs after the page has loaded, finds all search terms on that page inside each div with class
hentry (or ID
wrapper) and wraps them in
<mark class="hilite term-N"> ... </mark> tags. Note that N is a number starting with 0 for the first term used in the search phrase increasing 1 for each additional term used. Any part of a search phrase wrapped in quotes is considered as a single term.
What does it NOT do?
There are no CSS style rules set for highlighting. You are free to use any styling you wish but to make the highlights visible in browsers that do not support HTML5 like Internet Explorer 8 or older you absolutely need to define at least one rule. Modern HTML5 browsers will use their own highlighting style by default, which usually is a yellow marker style background.
So what do I need to do?
In most cases, it should just work. But you can do two things to ensure backward browser and theme compatibility:
1. Define CSS rules: There are no configuration options and there is no predefined highlight styling. You are completely free to define any CSS styling rules in your themes main stylesheet (style.css) or use any Custom CSS plugin like Custom CSS to get a result that fits your theme best. You can find basic instructions and CSS examples under the Other Notes tab.
2. Check your theme: In most up to date themes (including WP’s own default theme) post and page content is shown inside a div with class
hentry. This means search terms found in post and page content will be highlighted but not similar terms that accidentaly show in the page header, sidebar or footer. If your current theme does not use the
hentry class (yet), this plugin will look for IDs
main and finally
wrapper but if none of those are found, it will not work for you out of the box. See the last of the FAQ’s for ways to make it work.
Frequently Asked Questions
I do not see any highlighting!
This plugin has no configuration options page and there is no predefined highlight styling. For any highliting to become visible in browsers that do not support HTML5 like Internet Explorer 8 or older, you have to complete step II of the installation process. Edit your themes Stylesheet (style.css) to contain a rule that will give you exactly the styling that fits your theme.
Don’t want to edit your themes stylesheet? I can highly recommend Automattics own Custom CSS plugin!
I want to customise the highlighting but have no idea what to put in my stylesheet. Can you give me some examples?
Sure! See tab Other Notes for instructions and some examples to get you started.
I still do not see any highlighting!
Due to a problem with jQuery’s
Let’s suppose your theme’s index.php or single.php has no
<div <?php post_class() ?> ... > but wraps the post/page content in a
<div id="common" class="content"> ... </div>. You can do two things to solve this:
A. Change your theme and stylesheet so the post/page content div has either
<?php post_class() ?>. TIP: Take a look at how it is done in the Default theme included in each WordPress release. But this might involve some real timeconsuming tinkering with your stylesheet and several theme template files.
B. Change the source of wp-content/plugins/highlight-search-terms/hlst.php so that the array starting on line 55 contains your main content ID or class name. In the above example that can be either
'.content', where a prefix ‘#’ is used for ID and ‘.’ for class.
C. Switch to a theme that does abide by the current WordPress conventions
Latest version: Download Highlight Search Terms 1.3 [zip]
Downloaded 26709 times.