jboullion, Author at JBoullion

Highlight a search term and show its location in the excerpt

Sometimes a client will want the search term in the results page to show the first occurrence of the searched word in the content of that page. Here is some basic functionality to do that.

//attach the terms we found in pre_get_posts to our post results
add_action( 'posts_results', 'pk_posts_results_filter' );
function pk_posts_results_filter($posts){
	if ( is_search() ) {
		if(!empty($posts)) {
			foreach($posts as $post) {
				$matches = pk_find_search_word(get_search_query(), $post->post_content);
				if(!empty($matches)) {
					$post->post_excerpt = pk_add_highlight(get_search_query(), $post->post_content);
				}
			}
		}
	}
	return $posts;

}

//return any matches for a particular word
function pk_find_search_word($needle, $haystack){
	if(empty($needle)) return $haystack;

	//http://de.php.net/manual/en/function.preg-quote.php
	//Clean the needle so it doesn't break our preg_replace
	$needle = preg_quote($needle, '/');

	//Search for a need outside of any html tags
	preg_match("/($needle)(?![^<]*>|[^<>]*<i)/i", $haystack, $matches);

	return $matches;

}

//add a <span class="highlight"> to a word / phrase.
function pk_add_highlight($needle, $haystack){

	if(empty($needle)) return $haystack;

	//Clean the needle so it doesn't break our preg_replace
	$needle = preg_quote($needle, '/');

	$pattern = '/<.*?>/i';

	$haystack = pregReplaceAll($pattern, '', $haystack);

	$highlight_position = stripos($haystack,$needle);

	$highlight_position = $highlight_position < 50? 0: $highlight_position - 50;

	$highlighted = substr($haystack,$highlight_position,250);

	$highlighted = substr($highlighted, strpos($highlighted, " "));

	$highlighted = substr($highlighted, 1, strrpos($highlighted, " "));

	$highlighted = preg_replace("/($needle)(?![^<]*>|[^<>]*<i)/i", ' <span class="search-highlight">$1</span>', $highlighted);


	return ($highlight_position>0?'...':'').trim($highlighted).'...';

}


function pregReplaceAll($find, $replacement, $s) {
	while(preg_match($find, $s)) {
		$s = preg_replace($find, $replacement, $s);
	}

	return $s;
}

//attach the terms we found in pre_get_posts to our post results

add_action( 'posts_results', 'pk_posts_results_filter' );

function pk_posts_results_filter($posts){

if ( is_search() ) {

if(!empty($posts)) {

foreach($posts as $post) {

$matches = pk_find_search_word(get_search_query(), $post->post_content);

if(!empty($matches)) {

$post->post_excerpt = pk_add_highlight(get_search_query(), $post->post_content);

}

return $posts;

}

//return any matches for a particular word

function pk_find_search_word($needle, $haystack){

if(empty($needle)) return $haystack;

//http://de.php.net/manual/en/function.preg-quote.php

//Clean the needle so it doesn't break our preg_replace

$needle = preg_quote($needle, '/');

//Search for a need outside of any html tags

preg_match("/($needle)(?![^<]*>|[^<>]*<i)/i", $haystack, $matches);

return $matches;

}

//add a <span class="highlight"> to a word / phrase.

function pk_add_highlight($needle, $haystack){

if(empty($needle)) return $haystack;

//Clean the needle so it doesn't break our preg_replace

$needle = preg_quote($needle, '/');

$pattern = '/<.*?>/i';

$haystack = pregReplaceAll($pattern, '', $haystack);

$highlight_position = stripos($haystack,$needle);

$highlight_position = $highlight_position < 50? 0: $highlight_position - 50;

$highlighted = substr($haystack,$highlight_position,250);

$highlighted = substr($highlighted, strpos($highlighted, " "));

$highlighted = substr($highlighted, 1, strrpos($highlighted, " "));

$highlighted = preg_replace("/($needle)(?![^<]*>|[^<>]*<i)/i", ' <span class="search-highlight">$1</span>', $highlighted);

return ($highlight_position>0?'...':'').trim($highlighted).'...';

}

function pregReplaceAll($find, $replacement, $s) {

while(preg_match($find, $s)) {

$s = preg_replace($find, $replacement, $s);

}

return $s;

}

Add WordPress Stop Words

Sometimes a client will want to prevent certain words from being included in or affecting the search results. In order to remove these words from the search query we can just add them to the WP_Query stopwords like so:

// Add new stopwords to WP Query searches
add_filter( 'wp_search_stopwords', 'jb_stopwords', 10, 1 );
function jb_stopwords($stopwords) {
    //add the word 'and' to the list of stopwords so it doesn't affect the search results
    $stopwords[] = 'and';
    return $stopwords;
}

// Add new stopwords to WP Query searches

add_filter( 'wp_search_stopwords', 'jb_stopwords', 10, 1 );

function jb_stopwords($stopwords) {

//add the word 'and' to the list of stopwords so it doesn't affect the search results

$stopwords[] = 'and';

return $stopwords;

}

BBPress Filters

I have a tolerate/hate relationship with BBPress. I have worked with it a couple times now and I am not super happy with it. I think custom PHP forums or managed forums are better solutions when possible. Sometimes, they are not possible for some clients.

That said, using BBPress is FAR, FAR, FAR better than trying to build your own WordPress forum.

Here are some common filters I have used on BBPress to improve functionality.

//Get nickname instead of display name if possible
add_filter('bbp_get_reply_author_display_name','pk_bbp_get_reply_author_display_name',10,2);
function pk_bbp_get_reply_author_display_name($author_name, $reply_id){
	$author_id = bbp_get_reply_author_id($reply_id);
	$nick = get_the_author_meta( 'nickname', $author_id );
	return $nick ? $nick : $author_name;
}

add_filter('bbp_get_topic_author_display_name','pk_bbp_get_topic_author_display_name',10,2);
function pk_bbp_get_topic_author_display_name($author_name, $topic_id){
	$author_id = bbp_get_topic_author_id($topic_id);
	$nick = get_the_author_meta( 'nickname', $author_id );
	return $nick ? $nick : $author_name;
}

//Enable the Visual editor in bbPress
add_filter( 'bbp_after_get_the_content_parse_args', 'bbp_enable_visual_editor' );
function bbp_enable_visual_editor( $args = array() ) {
	$args['tinymce'] = true;
	return $args;
}

//Strip HTML tags from content that shouldn't be in place
add_filter( 'bbp_get_reply_content', 'pk_clean_bbpress_content', 100, 2 );
function pk_clean_bbpress_content( $content, $reply_id ) {
	$pattern = '/&lt;.*?&gt;/i';
	$content = preg_replace($pattern, '', $content);
	//$content = preg_replace($pattern, '', strip_tags($content));

	return $content;
}

//Force BBP to only ally pasting as plain text
add_filter( 'bbp_get_tiny_mce_plugins', 'bbp_tinymce_paste_plain_text' );
function bbp_tinymce_paste_plain_text( $plugins = array() ) {
	$plugins[] = 'paste';
	return $plugins;
}

//Get nickname instead of display name if possible

add_filter('bbp_get_reply_author_display_name','pk_bbp_get_reply_author_display_name',10,2);

function pk_bbp_get_reply_author_display_name($author_name, $reply_id){

$author_id = bbp_get_reply_author_id($reply_id);

$nick = get_the_author_meta( 'nickname', $author_id );

return $nick ? $nick : $author_name;

}

add_filter('bbp_get_topic_author_display_name','pk_bbp_get_topic_author_display_name',10,2);

function pk_bbp_get_topic_author_display_name($author_name, $topic_id){

$author_id = bbp_get_topic_author_id($topic_id);

$nick = get_the_author_meta( 'nickname', $author_id );

return $nick ? $nick : $author_name;

}

//Enable the Visual editor in bbPress

add_filter( 'bbp_after_get_the_content_parse_args', 'bbp_enable_visual_editor' );

function bbp_enable_visual_editor( $args = array() ) {

$args['tinymce'] = true;

return $args;

}

//Strip HTML tags from content that shouldn't be in place

add_filter( 'bbp_get_reply_content', 'pk_clean_bbpress_content', 100, 2 );

function pk_clean_bbpress_content( $content, $reply_id ) {

$pattern = '/<.*?>/i';

$content = preg_replace($pattern, '', $content);

//$content = preg_replace($pattern, '', strip_tags($content));

return $content;

}

//Force BBP to only ally pasting as plain text

add_filter( 'bbp_get_tiny_mce_plugins', 'bbp_tinymce_paste_plain_text' );

function bbp_tinymce_paste_plain_text( $plugins = array() ) {

$plugins[] = 'paste';

return $plugins;

}

Include Taxonomy Links in Search Results

By default WordPress (and many search plugins) will only find Posts associated with a category. So even if you search the exact category name, only posts which have that category will be listed.

We had a client that needed the category pages to be listed as well. Here is the solution I came up with to resolve that problem.

Step 1

Hook into our pre_get_posts and search our taxonomies with some custom queries.

add_action('pre_get_posts','jb_search_filter');
function jb_search_filter($query) {
    if ( ! is_admin() && $query->is_main_query() ) {
        if ($query->is_search) {
            global $wpdb;

            $search = $query->query_vars['s'];
			
            $term_ids = array();
                        
             //Find our terms based on their description
            $term_desc = $wpdb->get_col($wpdb->prepare("SELECT term_id FROM `{$wpdb->prefix}term_taxonomy` WHERE `description` LIKE '%s'", '%'.$search.'%'));

            //Find our terms based on their name
            $term_name = $wpdb->get_col($wpdb->prepare("SELECT term_id FROM `{$wpdb->prefix}terms` WHERE `name` LIKE '%s'", '%'.$search.'%'));
              
            //NOTE: You could probably combine the above queries with a JOIN but I prefer to have them separate in this instance
			
            //uniquely merge our results
            $term_ids = array_unique(array_merge($term_desc, $term_name));

            $get_terms_args = array (
				'taxonomy' => 'product_cat', //set your desired taxonomy slug here. This is the default Woocommerce taxonomy
				'orderby' => 'name',
				'order' => 'ASC',
				'hide_empty' => false,
				'include' => $term_ids,
			);

            $terms = get_terms($get_terms_args);

            //Here I am setting a static variable called "search_terms". You can find this function on my site. Or you can find your own way of saving / passing this data
            jb_set('search_terms',$terms);
        }
    }

    return $query;
}

add_action('pre_get_posts','jb_search_filter');

function jb_search_filter($query) {

if ( ! is_admin() && $query->is_main_query() ) {

if ($query->is_search) {

global $wpdb;

$search = $query->query_vars['s'];

$term_ids = array();

//Find our terms based on their description

$term_desc = $wpdb->get_col($wpdb->prepare("SELECT term_id FROM `{$wpdb->prefix}term_taxonomy` WHERE `description` LIKE '%s'", '%'.$search.'%'));

//Find our terms based on their name

$term_name = $wpdb->get_col($wpdb->prepare("SELECT term_id FROM `{$wpdb->prefix}terms` WHERE `name` LIKE '%s'", '%'.$search.'%'));

//NOTE: You could probably combine the above queries with a JOIN but I prefer to have them separate in this instance

//uniquely merge our results

$term_ids = array_unique(array_merge($term_desc, $term_name));

$get_terms_args = array (

'taxonomy' => 'product_cat', //set your desired taxonomy slug here. This is the default Woocommerce taxonomy

'orderby' => 'name',

'order' => 'ASC',

'hide_empty' => false,

'include' => $term_ids,

);

$terms = get_terms($get_terms_args);

//Here I am setting a static variable called "search_terms". You can find this function on my site. Or you can find your own way of saving / passing this data

jb_set('search_terms',$terms);

}

return $query;

}

Step 2

Attach the terms we found to our search results

add_action( 'posts_results', 'jb_posts_results_filter' );
function jb_posts_results_filter($posts){
	
    if ( is_search() ) {
        //get the terms we saved before
        $terms = jb_get('search_terms',$terms);
        //we can now merge our results. We know that there will not be any duplicates since WordPress doesn't include terms by default
        $posts = array_merge($terms, $posts);
    }
    return $posts;
}

add_action( 'posts_results', 'jb_posts_results_filter' );

function jb_posts_results_filter($posts){

if ( is_search() ) {

//get the terms we saved before

$terms = jb_get('search_terms',$terms);

//we can now merge our results. We know that there will not be any duplicates since WordPress doesn't include terms by default

$posts = array_merge($terms, $posts);

}

return $posts;

}

Step 3

No code here, but just be aware that on your search page your $post object in the loop will not have “post_title” or other default post values. So you will need to check if the “$post” you are handling is a term and then set it up correctly.

Good luck!

file_get_contents cURL replacement

Some hosting providers disable file() and file_get_contents() by default. However, cURL should still be available. If that is the case you can use this function as a replacement for file_get_contents().

function file_get_contents_curl($url) {
    $ch = curl_init();

    curl_setopt($ch, CURLOPT_AUTOREFERER, TRUE);
    curl_setopt($ch, CURLOPT_HEADER, 0);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE);       

    $data = curl_exec($ch);
    curl_close($ch);

    return $data;
}

function file_get_contents_curl($url) {

$ch = curl_init();

curl_setopt($ch, CURLOPT_AUTOREFERER, TRUE);

curl_setopt($ch, CURLOPT_HEADER, 0);

curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

curl_setopt($ch, CURLOPT_URL, $url);

curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE);

$data = curl_exec($ch);

curl_close($ch);

return $data;

}

Reorder Posts By Menu Order, then Post Title

This can be done using $args = array( ‘orderby’ => array(‘menu_order’,’title’)) however then you are using a 0 index menu_order (0 menu order goes first) and the first letter of the post title (rather than by say, the last name in the post title). So this is just a function to give a little more control over that ordering

//sort our posts by their menu_order then by alpha value
function jb_reorder_posts($a, $b){
	
	//First take anyone with a menu order and order then first
	if($a->menu_order && ! $b->menu_order){
		return -1;
	}else if(! $a->menu_order && $b->menu_order){
		return 1;
	}else if($a->menu_order > $b->menu_order){
		return 1;
	}else if($a->menu_order < $b->menu_order){
		return -1;
	}

	//if neither person has a menu order, order by last name
	//$a_last_name = end(explode(' ', $a->post_title));
	//$b_last_name = end(explode(' ', $b->post_title));

	//return strcmp($a_last_name, $b_last_name);
        return strcmp($a->post_title, $b->post_title);
}

//Using WP_Query
usort($new_query->posts, 'jb_reorder_posts' );

//Using get_posts()
usort($posts, 'jb_reorder_posts' );

//sort our posts by their menu_order then by alpha value

function jb_reorder_posts($a, $b){

//First take anyone with a menu order and order then first

if($a->menu_order && ! $b->menu_order){

return -1;

}else if(! $a->menu_order && $b->menu_order){

return 1;

}else if($a->menu_order > $b->menu_order){

return 1;

}else if($a->menu_order < $b->menu_order){

return -1;

}

//if neither person has a menu order, order by last name

//$a_last_name = end(explode(' ', $a->post_title));

//$b_last_name = end(explode(' ', $b->post_title));

//return strcmp($a_last_name, $b_last_name);

return strcmp($a->post_title, $b->post_title);

}

//Using WP_Query

usort($new_query->posts, 'jb_reorder_posts' );

//Using get_posts()

usort($posts, 'jb_reorder_posts' );