<?php
//load
class GP_Testimonial
{
var $testimonial;
var $atts;
var $config;
var $cache_key;
//$data can be false when this is used from the single testimonial content filter
function __construct($data = false, $config = array())
{
//setup data
//if testimonial data is empty, setup a blank testimonial object
$this->testimonial = !empty($data['testimonial']) ? $data['testimonial'] : new stdClass;
//store config data
$this->config = $config;
//setup atts
$data['atts'] = (!isset($data['atts'])) ? '' : $data['atts'];//PHP 7.4 notice fix
$this->atts = $this->merge_default_attributes($data['atts']);
//setup our custom excerpts
add_filter('get_the_excerpt', array($this, 'easy_t_fix_testimonial_excerpts') );
add_filter('excerpt_length', array($this, 'easy_t_excerpt_length') );
add_filter('easy_testimonials_the_content', array($this, 'easy_testimonials_the_content_filter') );
//if we have a testimonial, create a cache key
if( isset($this->testimonial->ID) ){
$this->cache_key = "easy_t_" . $this->testimonial->ID . md5( serialize($this->atts) );
}
//add any declared default atts from our theme
//add_filter('easy_testimonials_default_attributes' , array($this, 'load_theme_atts'));
//load custom template file if our chosen theme calls for it
add_filter( 'easy_t_template_filename', array($this, 'use_theme_template'), 10, 2 );
}
// Remove unwanted HTML comments
function strip_html_comments($content)
{
return preg_replace('/<!--(.|\s)*?-->/', '', $content);
}
//renders this testimonial
//uses transient caching
function render(){
$output = "";
//if enabled, use cache
if( $this->config->cache_enabled ){
// Get any existing copy of our transient data
if ( false === ($output = get_transient($this->cache_key)) ){
// It wasn't there, so regenerate the data and save the transient
$output .= $this->easy_t_get_single_testimonial_html();
set_transient( $this->cache_key, $output, $this->config->cache_time );
}
} else {
$output .= $this->easy_t_get_single_testimonial_html();
}
$this->safely_display_testimonial($output);
}
function safely_display_testimonial($output)
{
$output = $this->strip_html_comments($output);
$tags = wp_kses_allowed_html('post');
$tags['script'] = true; // have to allow <script> tags for JSON-LD markup
$tags['div']['style'] = true; // allow div's to have style attributes
add_filter( 'safe_style_css', array($this, 'allow_display_in_style'));
echo wp_kses($output, $tags);
remove_filter( 'safe_style_css', array($this, 'allow_display_in_style'));
}
// by default, WordPress strips out 'display' from style attributes
// this filter re-allows 'display'
function allow_display_in_style($styles)
{
if ( !in_array('display', $styles) ){
$styles[] = 'display';
}
return $styles;
}
//using the current theme set in the testimonial object
//load the theme's header information
//and set any relevant attributes
function load_theme_atts(){
//load currently selected theme
$theme = $this->atts['theme'];
//translate to the registered name
//our registered theme names have a specific pattern they follow from the option value
//easy_testimonials_$theme_style
$theme = sanitize_file_name($theme . "_style");
//load file data from top of css file
$file_data = get_file_data($this->config->dir_path . $theme, $this->atts);
return $file_data;
}
//TODO: change custom CSS box to output CSS this way: https://codex.wordpress.org/Function_Reference/wp_add_inline_style
// performs needed steps for choosing which single template to load
// @param $filename The currently set template filename
// @param $current_theme The currently chosen theme
function use_theme_template( $filename, $current_theme )
{
//array of themes that use a custom template
$templates_for_themes = array(
'single_testimonial-accolades_style.php' => array(
'red-accolades_style',
'blue-accolades_style',
'black-accolades_style',
'grey-accolades_style',
'green-accolades_style',
),
'single_testimonial-merit_style.php' => array(
'green-merit_style',
'red-merit_style',
'orange-merit_style',
'purple-merit_style',
'grey-merit_style',
),
'single_testimonial-classic_style.php' => array(
'light_grey-classic_style',
'red-classic_style',
'gold-classic_style',
'blue-classic_style',
'dark_grey-classic_style',
),
'single_testimonial-compliments_style.php' => array(
'dark_grey-compliments_style',
'blue-compliments_style',
'green-compliments_style',
'light_grey-compliments_style',
'red-compliments_style',
),
'single_testimonial-ribbon_style.php' => array(
'green-ribbon_style',
'blue-ribbon_style',
'teal-ribbon_style',
'gold-ribbon_style',
'grey-ribbon_style',
),
);
//look for a match between the current theme and our themes w/ templates array
//$current_theme might have "style-" prepended to it, so go ahead and try and remove it too
$current_theme = str_replace("style-", "", $current_theme);
$template_filename = $this->search_parent_key( $current_theme, $templates_for_themes );
//if a match is found, use the corresponding filename
if( !empty( $template_filename ) ){
$filename = $template_filename;
}
return $filename;
}
// loop through multidimensional array searching for value
// when found, return key of parent array
// @param $value The value that you are searching for
// @param $arr The multidimensional array that you are searching through
function search_parent_key( $value, $arr )
{
foreach($arr as $key => $val) {
if(in_array($value,$val)) {
return $key;
}
}
}
function merge_default_attributes($atts){
$defaults = array(
'testimonials_link' => get_option('testimonials_link'),
'show_title' => 0,
'count' => -1,
'body_class' => 'testimonial_body',
'author_class' => 'testimonial_author',
'id' => '',
'use_excerpt' => false,
'reveal_full_content' => false, // setting this implies use_excerpt = true
'category' => '',
'show_thumbs' => get_option('testimonials_image', true),
'short_version' => false,
'orderby' => 'date',//'none','ID','author','title','name','date','modified','parent','rand','menu_order'
'order' => 'DESC',//'ASC, DESC'
'show_rating' => 'stars',
'paginate' => false,
'testimonials_per_page' => 10,
'theme' => get_option('testimonials_style', 'light_grey-classic_style'),
'show_position' => true,
'show_date' => true,
'show_other' => true,
'width' => false,
'hide_view_more' => true,
'meta_data_position' => get_option('meta_data_position') ? "above" : "below",
'output_schema_markup' => get_option('easy_t_output_schema_markup', true)
);
if(empty($atts)){
$atts = array();
}
$merged_atts = array_merge($defaults, $atts);
return apply_filters('easy_testimonials_default_attributes' , $merged_atts);
}
//runs when viewing a single testimonial's page (ie, you clicked on the continue reading link from the excerpt)
function single_testimonial_content_filter($content){
global $easy_t_in_widget;
global $post;
// Save the post data in a variable before resetting it. It *shouldn't* matter,
// but some plugins might be depending on the global $post being left in whatever
// state it was when we got here
$old_post = $post;
wp_reset_postdata();
//not running in a widget, is running in a single view or archive view such as category, tag, date, the post type is a testimonial
if ( empty($easy_t_in_widget) && (is_singular() || is_archive()) && get_post_type( $post->ID ) == 'testimonial' ) {
//stored needed values for reference
$this->testimonial->ID = $post->ID;
//build and return the single testimonial html
$content = $this->easy_t_get_single_testimonial_html( true );
}
// restore post data to its previous, possibly borked, form
$post = $old_post;
setup_postdata($post);
return $content;
}
//passed an array of acceptable shortcode attributes
//this function will build a string of classes representing the chosen attributes
//returns string ready for echoing as classes
function easy_t_build_classes_from_atts($atts = array()){
$class_string = "";
foreach ($atts as $key => $value){
$class_string .= " " . $value . "_" . $key;
}
return $class_string;
}
function easy_t_get_the_excerpt( $post_id )
{
//preserve the old post data for other plugins/themes/etc.
global $post;
$save_post = $post;
//run our own excerpt function that trims the excerpt without applying the content filter
$post = get_post($post_id);
if ( !empty($post->post_excerpt) ) {
$excerpt_more = $this->easy_t_excerpt_more( '' , $post );
$post_excerpt = apply_filters( 'easy_t_get_the_excerpt', $post->post_excerpt . $excerpt_more, $post );
} else {
$post_excerpt = '';
}
$output = $this->easy_t_trim_excerpt($post_excerpt , $post);
//reset global postdata to saved postdata
$post = $save_post;
return $output;
}
/* excerpt update 4.14 */
/* Keep the extra info we've added with the_content filter from appearing in the excerpt*/
//moved to construct 2.0
//add_filter('get_the_excerpt', 'easy_t_fix_testimonial_excerpts');
function easy_t_fix_testimonial_excerpts($excerpt)
{
global $post;
$post = get_post();
// if not a testimonial, move on
if ( empty( $post ) || $post->post_type !== 'testimonial' ) {
return $excerpt;
}
return wp_trim_words($excerpt, 20);
}
/**
* Our own version of wp_trim_excerpt that:
* 1) can be run on any post (instead of only the global)
* 2) doesn't run the_content filter
*
* Else all is the same (runs all the normal filters, etc).
*
* @param $text Excerpt, which will likely be empty. If empty,
* it wil be generated in the normal way, except
* without running the_content filter.
*
* @param $post The post to use for the excerpt. If not provided,
* global $post is used
*
* @return string The excerpt (after wp_trim_excerpt has been applied).
*
*/
function easy_t_trim_excerpt( $text = '', $post = false ) {
if (!$post) {
$post = get_post();
}
$raw_excerpt = $text;
if ( '' == $text ) {
$text = $post->post_content;
$text = strip_shortcodes( $text );
/** This filter is documented in wp-includes/post-template.php */
//$text = apply_filters( 'the_content', $text );
$text = str_replace(']]>', ']]>', $text);
/**
* Filter the number of words in an excerpt.
*
* @since 2.7.0
*
* @param int $number The number of words. Default 55.
*/
$excerpt_length = apply_filters( 'excerpt_length', 55 );
/**
* Filter the string in the "more" link displayed after a trimmed excerpt.
*
* @since 2.9.0
*
* @param string $more_string The string shown within the more link.
*/
add_filter( 'excerpt_more', array($this, 'easy_t_excerpt_more'), 9999, 2 );
$excerpt_more = $this->easy_t_excerpt_more( '' , $post );
$excerpt_more = apply_filters( 'excerpt_more', $excerpt_more );
$text = wp_trim_words( $text, $excerpt_length, $excerpt_more );
remove_filter( 'excerpt_more', array($this, 'easy_t_excerpt_more'), 9999 );
}
/**
* Filter the trimmed excerpt string.
*
* @since 2.8.0
*
* @param string $text The trimmed text.
* @param string $raw_excerpt The text prior to trimming.
*/
return apply_filters( 'wp_trim_excerpt', $text, $raw_excerpt );
}
/* add customized continue reading link to testimonials, if set */
function easy_t_excerpt_more( $more, $the_post = false ) {
global $post;
if ( empty($the_post) ) {
$the_post = $post;
}
if(get_option('easy_t_link_excerpt_to_full', false)){
$retval = ' <a class="more-link" href="' . get_permalink( $the_post->ID ) . '">' . get_option('easy_t_excerpt_text') . '</a>';
} else {
$retval = ' ' . get_option('easy_t_excerpt_text');
}
return apply_filters( 'easy_testimonials_excerpt_more', $retval, $more, $the_post );
}
//checks to see if this is a testimonial
//if it is, loads custom excerpt length and uses it
//otherwise use current wordpress setting
function easy_t_excerpt_length( $length ) {
global $post;
//if this is a testimonial, use our customization
if( ! empty($post->post_type) && 'testimonial' == $post->post_type ) {
return get_option('easy_t_excerpt_length',55);
}
return $length;
}
//passed a string
//finds a matching theme or loads the theme currently selected on the options page
//returns appropriate class name string to match theme
//if return_theme_base is true, returns the base string of the theme (without the style modifier)
function easy_t_get_theme_class($theme_string = '', $return_theme_base = false)
{
// use default theme if no theme was specified
$the_theme = !empty($theme_string)
? $theme_string
: get_option('testimonials_style', 'light_grey-classic_style');
// sanitize theme name: only allow letters, numbers, underscore, and dash
$the_theme = preg_replace("/[^A-Za-z0-9\-_]/", '', $the_theme);
//remove style from the middle of our theme options and place it as a prefix
//matching our CSS files
$the_theme = str_replace('-style', '', $the_theme);
$the_theme = "style-" . $the_theme;
return $the_theme;
}
/*
* Assemble the json-ld review markup for an individual testimonial
* TBD: support for type of and image of item reviewed
*/
function output_jsonld_markup($testimonial){
/* json ld example:
<script type="application/ld+json">
{
"@context": "http://schema.org/",
"@type": "Review",
"itemReviewed": {
"@type": "Restaurant",
"image": "http://www.example.com/seafood-restaurant.jpg",
"name": "Legal Seafood"
},
"reviewRating": {
"@type": "Rating",
"ratingValue": "4"
},
"name": "A good seafood place.",
"author": {
"@type": "Person",
"name": "Bob Smith"
},
"reviewBody": "The seafood is great.",
"publisher": {
"@type": "Organization",
"name": "Washington Times"
}
}
</script>
*/
//prevent errors from unset rating
if( empty($testimonial['num_stars']) ){
$testimonial['num_stars'] = 5;
}
ob_start();
?>
<script type="application/ld+json">
{
"@context": "http://schema.org/",
"@type": "Review",
"itemReviewed": {
"@type": "Organization",
"name": <?php echo json_encode( $this->easy_t_clean_html($testimonial['other']) ); ?>
},
"reviewRating": {
"@type": "Rating",
"ratingValue": <?php echo json_encode( $testimonial['num_stars'] ); ?>,
"bestRating": "5"
},
"name": <?php echo json_encode( get_the_title( $testimonial['id'] ) ); ?>,
"author": {
"@type": "Person",
"name": <?php echo json_encode( $this->easy_t_clean_html($testimonial['client']) ); ?>
},
"reviewBody": <?php echo json_encode( strip_tags($testimonial['content']) ); ?>
}
</script>
<?php
$content = ob_get_contents();
ob_end_clean();
$output = apply_filters( "easy_testimonials_json_ld", $content, $testimonial );
$allowed_tags = array(
'script' => array(
'type' => true,
)
);
echo wp_kses( $output, $allowed_tags );
}
/*
* Assemble the html for the testimonials metadata taking into account current options
* @deprecated 2.3.1
* @deprecated No longer used by internal code and not recommended.
*/
function easy_testimonials_build_metadata_html($testimonial, $author_class, $show_date, $show_rating, $show_other)
{
//set the following variables to true if the option to display the associated item is true
//and the associated item has content in it
//(preventing outputting blank items that insert whitespace)
$show_the_client = (strlen($testimonial['client'])>0) ? true : false;
$show_the_position = (strlen($testimonial['position'])>0) ? true : false;
$show_the_other = (strlen($testimonial['other'])>0 && $show_other) ? true : false;
$show_the_date = (strlen($testimonial['date'])>0 && $show_date) ? true : false;
$show_the_rating = (strlen($testimonial['num_stars'])>0 && ($show_rating == "stars")) ? true : false;
?>
<p class="<?php echo esc_attr($author_class); ?>">
<?php //if any of the items have data and are set to be displayed, construct the html ?>
<?php if($show_the_client || $show_the_position || $show_the_other || $show_the_date || $show_rating == "stars" ): ?>
<cite>
<?php if($show_the_client): ?>
<span class="testimonial-client" style="<?php echo esc_attr($client_css); ?>"><?php echo esc_html( $this->easy_t_clean_html($testimonial['client']) );?></span>
<?php endif; ?>
<?php if($show_the_position): ?>
<span class="testimonial-position" style="<?php echo esc_attr($position_css); ?>"><?php echo esc_html( $this->easy_t_clean_html($testimonial['position']) );?></span>
<?php endif; ?>
<?php if($show_the_other): ?>
<span class="testimonial-other" style="<?php echo esc_attr($other_css); ?>"><?php echo esc_html( $this->easy_t_clean_html($testimonial['other']) );?></span>
<?php endif; ?>
<?php if($show_the_date): ?>
<span class="date" style="<?php echo esc_attr($date_css); ?>"><?php echo esc_html( $this->easy_t_clean_html($testimonial['date']) );?></span>
<?php endif; ?>
<?php if($show_the_rating): ?>
<?php if(strlen($testimonial['num_stars'])>0): ?>
<span class="stars">
<?php
$x = 5; //total available stars
//output dark stars for the filled in ones
for($i = 0; $i < $testimonial['num_stars']; $i ++){
echo '<span class="dashicons dashicons-star-filled"></span>';
$x--; //one less star available
}
//fill out the remaining empty stars
for($i = 0; $i < $x; $i++){
echo '<span class="dashicons dashicons-star-filled empty"></span>';
}
?>
</span>
<?php endif; ?>
<?php endif; ?>
</cite>
<?php endif; ?>
</p>
<?php
}
/*
* Assemble the HTML for the Testimonial Image taking into account current options
*/
function build_testimonial_image($postid, $override_size = ''){
//load image size settings
if ( !empty($override_size) ) {
$testimonial_image_size = $override_size;
} else {
$testimonial_image_size = get_option('easy_t_image_size');
}
if(strlen($testimonial_image_size) < 2){
$testimonial_image_size = "easy_testimonial_thumb";
$width = 50;
$height = 50;
} else {
//one of the default sizes, load using get_option
if( in_array( $testimonial_image_size, array( 'thumbnail', 'medium', 'large' ) ) ){
$width = get_option( $testimonial_image_size . '_size_w' );
$height = get_option( $testimonial_image_size . '_size_h' );
//size added by theme, user, or plugin
//load using additional image sizes global
}else{
global $_wp_additional_image_sizes;
if( isset( $_wp_additional_image_sizes ) && isset( $_wp_additional_image_sizes[ $testimonial_image_size ] ) ){
$width = $_wp_additional_image_sizes[ $testimonial_image_size ]['width'];
$height = $_wp_additional_image_sizes[ $testimonial_image_size ]['height'];
}
}
}
//use whichever of the two dimensions is larger
$size = ($width > $height) ? $width : $height;
//load testimonial's featured image
// we are suppressing error output as there is an issue causing image imports that fail
// to place a WP_Error object as the image, which causes a lot of hullaballoo
// this has been fixed in the importer / exporter, this remains for legacy testimonials
$image = @get_the_post_thumbnail($postid, $testimonial_image_size);
//if no featured image is set
if (strlen($image) < 2){
//load client information for use with avatars
$client_email = get_post_meta($postid, '_ikcf_email', true);
$client_name = get_post_meta($postid, '_ikcf_client', true);
//are gravatars enabled and do you have a gravatar? return it
if( get_option('easy_t_gravatar', 1) && $this->gratavar_exists_for_email($client_email) ) { // a gravatar exists for this email, so generate the gratavar URL, using the mystery person as a fallback
$gravatar = md5( strtolower(trim($client_email)) );
$image = '<img class="attachment-'.$testimonial_image_size.' wp-post-image easy_testimonial_gravatar" alt="default gravatar" src="//www.gravatar.com/avatar/' . $gravatar . '?s=' . $size . '" />';
} else {
// gravatars are not enabled, or no gravatar exists for this email, so use a fallback image
$image = $this->get_fallback_image_tag($postid, $client_name, $testimonial_image_size);
}
}
return $image;
}
/* Decide which type of fallback image to use - Text Based Avatars, or
* Mystery Person (more options to be added)
*
* @param $client_name string Optional. Client name, for use in generating
* a text based avatar.
*
* @return string The image tag containing the fallback image.
*/
function get_fallback_image_tag($testimonial_id, $client_name = '', $testimonial_image_size = '')
{
// TODO: load this setting via a radio option, not one option for each choice.
// that would mean this probably becomes a switch statement
$fallback_image_method = get_option('easy_t_fallback_image_method', '');
if ( empty( $fallback_image_method ) ){
$fallback_image_method = "text_based_avatars";
if ( get_option( 'easy_t_mystery_person', 0 ) ){
$fallback_image_method = "mystery_person";
}
}
switch ( $fallback_image_method ){
case "smart_text_avatars":
$classes = 'attachment-'.$testimonial_image_size.' wp-post-image easy_testimonial_fallback';
if ( 'large' == $testimonial_image_size ) {
$image = $this->config->smart_text_avatar_generator->get_image_tag($client_name, 800, 800, $classes);
} else {
$image = $this->config->smart_text_avatar_generator->get_image_tag($client_name, 150, 150, $classes);
}
break;
case "no_image":
$image = "";
break;
case "mystery_person":
case "mystery_person":
default:
// use mystery person
$image = '<img class="attachment-'.$testimonial_image_size.' wp-post-image easy_testimonial_mystery_person" alt="default image" src="' . $this->config->url_path . 'assets/img/mystery-person.png' . '" />';
break;
}
return apply_filters('easy_t_fallback_image_tag', $image, $testimonial_id);
}
/*
* Generates and returns the HTML for a given testimonial,
* considering the shortcode attributes provided.
*
* @param integer $postid The post ID of the testimonial
* @param array $atts The shortcode attributes to use for build this testimonial
*
* @return string The HTML output for this testimonial
*/
function easy_t_get_single_testimonial_html($is_single = false)
{
global $post;
$view_vars = new stdClass;
$postid = $this->testimonial->ID;
//if this is being loaded from the single post view
//then we already have the post data setup (we are in The Loop)
//so skip this step
if(!$is_single){
setup_postdata( $this->testimonial );
}
//if this is a single (via the permalink) testimonial
//then we need to load our display atts from the settings panel
if($is_single){
$single_testimonial_view_settings = array(
'show_title' => get_option('easy_t_single_view_show_title', 0),
'show_thumbs' => get_option('easy_t_single_view_show_thumbs', true),
'show_rating' => get_option('easy_t_single_view_show_rating', 'stars'),
'theme' => get_option('easy_t_single_view_theme', 'light_grey-classic_style'),
'show_position' => get_option('easy_t_single_view_show_position', true),
'show_date' => get_option('easy_t_single_view_show_date', true),
'show_other' => get_option('easy_t_single_view_show_other', true),
'width' => get_option('easy_t_single_view_width', false),
'hide_view_more' => get_option('easy_t_single_view_hide_view_more', true),
'meta_data_position' => get_option('easy_t_single_view_meta_data_position') ? "above" : "below",
'output_schema_markup' => get_option('easy_t_single_view_output_schema_markup', true)
);
$this->atts = $this->merge_default_attributes($single_testimonial_view_settings);
}
//empty array to place all the testimonial data
$view_vars->display_testimonial = array();
//load date format from settings
//RWG: pass get_the_date nothing to fallback to WordPress date format settings
$date_format = get_option('easy_t_date_format', '');
$view_vars->display_testimonial['date'] = get_the_date($date_format, $postid);
$added_excerpt_filter = false;
$view_vars->display_testimonial['title'] = get_the_title($postid);
// add a link to reveal the full content (if specified; default is to not)
if ( !empty($this->atts['reveal_full_content']) ) {
$view_vars->display_testimonial['full_content'] = get_post_field('post_content', $this->testimonial->ID);
add_filter( 'easy_testimonials_excerpt_more', array($this, 'force_excerpt_text_to_ellipsis'), 10, 3 );
$added_excerpt_filter = true;
}
if($this->atts['use_excerpt'] && !$is_single){
$view_vars->display_testimonial['content'] = $this->easy_t_get_the_excerpt( $this->testimonial->ID );
if ( !empty($this->atts['reveal_full_content']) ) {
$view_vars->display_testimonial['full_content'] = get_post_field('post_content', $this->testimonial->ID);
}
} else {
$view_vars->display_testimonial['content'] = get_post_field('post_content', $this->testimonial->ID);
}
// gutenberg adds an extraneous html comment before and after every block, which will later
// get converted // to <p>'s with nothing but the HTML comment in them.
// so we strip the comments now to prevent this.
// NOTE: We would (and do) simply remove the wpautop filter, but Gutenberg keeps turning it back on
$view_vars->display_testimonial['content'] = $this->remove_html_comments($view_vars->display_testimonial['content']);
//apply our content filter, if flag set
if( get_option('easy_t_apply_content_filter', false) || $is_single ){
$view_vars->display_testimonial['content'] = $this->easy_testimonials_the_content_filter( $view_vars->display_testimonial['content'] );
} else {
$view_vars->display_testimonial['content'] = wpautop( $view_vars->display_testimonial['content'] );
}
$view_vars->display_testimonial['id'] = $this->testimonial->ID;
//load rating
//if set, append english text to it
$view_vars->display_testimonial['rating'] = get_post_meta($this->testimonial->ID, '_ikcf_rating', true);
$view_vars->display_testimonial['num_stars'] = ''; //reset num stars (Thanks Steve@IntegrityConsultants!)
if(strlen($view_vars->display_testimonial['rating'])>0){
$view_vars->display_testimonial['num_stars'] = $view_vars->display_testimonial['rating'];
$view_vars->display_testimonial['rating'] = '<p class="easy_t_ratings" itemprop="reviewRating" itemscope itemtype="http://schema.org/Rating"><meta itemprop="worstRating" content = "1"/><span itemprop="ratingValue" >' . esc_html($view_vars->display_testimonial['rating']) . '</span>/<span itemprop="bestRating">5</span> Stars.</p>';
}
//if nothing is set for the short content, use the long content
if(strlen($view_vars->display_testimonial['content']) < 2){
$view_vars->display_testimonial['content'] = $post->post_excerpt;
if($this->atts['use_excerpt']){
if($view_vars->display_testimonial['content'] == ''){
$view_vars->display_testimonial['content'] = wp_trim_excerpt($post->post_content);
}
} else {
$view_vars->display_testimonial['content'] = $post->post_content;
}
}
if(strlen($this->atts['show_rating'])>2){
if($this->atts['show_rating'] == "before"){
$view_vars->display_testimonial['content'] = $view_vars->display_testimonial['rating'] . ' ' . $view_vars->display_testimonial['content'];
}
if($this->atts['show_rating'] == "after"){
$view_vars->display_testimonial['content'] = $view_vars->display_testimonial['content'] . ' ' . $view_vars->display_testimonial['rating'];
}
}
$override_size = '';
if ( strpos($this->atts['theme'], 'compliments_style') !== false ) {
$override_size = 'large';
}
if ($this->atts['show_thumbs']) {
$view_vars->display_testimonial['image'] = $this->build_testimonial_image($this->testimonial->ID, $override_size);
$view_vars->display_testimonial['image_src'] = $this->extract_image_source($view_vars->display_testimonial['image']);
}
$view_vars->display_testimonial['client'] = get_post_meta($this->testimonial->ID, '_ikcf_client', true);
$view_vars->display_testimonial['position'] = get_post_meta($this->testimonial->ID, '_ikcf_position', true);
$view_vars->display_testimonial['other'] = get_post_meta($this->testimonial->ID, '_ikcf_other', true);
//if this testimonial doesn't have a value for the item being reviewed
//and if the use global item reviewed setting is checked
//use the global item reviewed value in for the current testimonial
if( (strlen($view_vars->display_testimonial['other'])<2) && get_option('easy_t_use_global_item_reviewed',false) ){
$view_vars->display_testimonial['other'] = get_option('easy_t_global_item_reviewed','');
}
//load a list of of easy testimonial categories associated with this testimonial
//loop through list and build a string of category slugs
//we will append these to the wrapping HTML of the single testimonial for advanced customization
$terms = wp_get_object_terms( $this->testimonial->ID, 'easy-testimonial-category');
$term_list = '';
foreach($terms as $term){
$term_list .= "easy-t-category-" . $term->slug . " ";
}
//build attribute based classes for extra customization options
$atts_for_classes = array(
'thumbs' => ($this->atts['show_thumbs']) ? 'show' : 'hide',
'title' => ($this->atts['show_title']) ? 'show' : 'hide',
'position' => ($this->atts['show_position']) ? 'show' : 'hide',
'date' => ($this->atts['show_date']) ? 'show' : 'hide',
'rating' => $this->atts['show_rating'],
'other' => ($this->atts['show_other']) ? 'show' : 'hide'
);
$view_vars->attribute_classes = $this->easy_t_build_classes_from_atts($atts_for_classes);
//add the category slugs to the list of classes to output
//make sure to include the extra space so we aren't butting classes up against each other
$view_vars->attribute_classes .= " " . $term_list;
//get classes for current theme
$view_vars->output_theme = $this->easy_t_get_theme_class($this->atts['theme']);
//get width from our width option or shortcode attribute (if set)
$view_vars->width_value = !empty($this->atts['width']) ? $this->atts['width'] : get_option('easy_t_width','');
//only output width style if a width is set
$view_vars->width_style = !empty($view_vars->width_value) ? 'style="width: ' . $view_vars->width_value . '"' : '';
//if the "Show View More Testimonials Link" option is checked
//and the hide_view_more attribute is not set
//then set $show_view_more to true
//else set to false
$view_vars->show_view_more = (get_option('easy_t_show_view_more_link',false) && !$this->atts['hide_view_more']) ? true : false;
//set the following variables to true if the option to display the associated item is true
//and the associated item has content in it
//(preventing outputting blank items that insert whitespace)
$view_vars->testimonial_metadata['show_the_client'] = !empty($view_vars->display_testimonial['client']);
$view_vars->testimonial_metadata['show_the_position'] = ( !empty($view_vars->display_testimonial['position']) && $this->atts['show_position'] );
$view_vars->testimonial_metadata['show_the_other'] = ( !empty($view_vars->display_testimonial['other']) && $this->atts['show_other']);
$view_vars->testimonial_metadata['show_the_date'] = ( !empty($view_vars->display_testimonial['date']) && $this->atts['show_date']);
$view_vars->testimonial_metadata['show_the_rating'] = ( !empty($view_vars->display_testimonial['num_stars']) && ($this->atts['show_rating'] == "stars") );
//last chance to customize testimonial data before rendering template
$view_vars->display_testimonial = apply_filters('easy_t_display_testimonial_data', $view_vars->display_testimonial);
//last chance to customize attributes before rendering template
$view_vars->atts = apply_filters('easy_t_display_attributes' , $this->atts);
//last chance to customize metadata before rendering template
$view_vars->testimonial_metadata = apply_filters('easy_t_display_metadata', $view_vars->testimonial_metadata);
//last chance to load a different template
$template_filename = apply_filters( 'easy_t_template_filename', 'single_testimonial.php', $view_vars->output_theme );
$output = $this->render_single_testimonial($view_vars, $template_filename);
wp_reset_postdata();
if ( $added_excerpt_filter ) {
remove_filter( 'easy_testimonials_excerpt_more', array($this, 'force_excerpt_text_to_ellipsis'), 10, 2 );
}
//apply filter with the current output, the current testimonial array, the current attributes, and the current testimonial's ID
return apply_filters('easy_t_get_single_testimonial_html', $output, $view_vars->display_testimonial, $this->atts, $postid);
}
function render_single_testimonial($view_vars, $template_filename = 'single_testimonial.php')
{
//last chance to load a different template
$template_filename = apply_filters( 'easy_t_template_filename', $template_filename, $view_vars->output_theme );
return $this->get_template_content($template_filename, '', $view_vars);
}
function force_excerpt_text_to_ellipsis($excerpt_text, $more, $post)
{
return '…'; // ellipsis
}
function get_template_content($template_name, $default_content = '', $view_vars = array() )
{
$template_path = $this->get_template_path($template_name);
if (file_exists($template_path)) {
//array merge atts and metadata so extract produces correctly named vars
$view_vars = array_merge( (array)$view_vars, $view_vars->atts );
$view_vars = array_merge( $view_vars, $view_vars['testimonial_metadata'] );
// load template by including it in an output buffer, so that variables and PHP will be run
ob_start();
extract( $view_vars );
include($template_path);
$content = ob_get_contents();
ob_end_clean();
return $content;
}
// couldn't find a matching template file, so return the default content instead
return $default_content;
}
function get_template_path($template_name)
{
// checks if the file exists in the theme first,
// otherwise serve the file from the plugin
if ( $theme_file = locate_template( array ( 'easy-testimonials/' . $template_name ) ) ) {
$template_path = $theme_file;
} else {
$template_path = plugin_dir_path( __FILE__ ) . '../templates/' . $template_name;
}
return apply_filters( 'easy_t_template_path', $template_path, $template_name );
}
//check to see if HTML is allowed in testimonials
//if so, leave $html unfiltered
//otherwise, run wp_strip_all_tags on $html
//return $html
function easy_t_clean_html( $html = "" ){
// strip all tags unless special constant is defined
if( !defined('EASY_TESTIMONIALS_ALLOW_HTML') ) {
$html = wp_strip_all_tags( $html );
}
return $html;
}
function easy_testimonials_the_content_filter($content)
{
//remove our special content filter before applying the default content filter, to prevent recursion
//this global is here because you have to remove class based filters using the same instance that added them.
global $gp_testimonial_class;
remove_filter( 'the_content', array($gp_testimonial_class, 'single_testimonial_content_filter') );
//Prevent infinite recursion from multiple applications of the_content filter from other plugins
//
// 1) remove the pagebuilder filter (for pagebuilder < v2.5) and apply the content filter
// 2) if the pagebuilder class doesn't exist (ie, we don't any version of pagebuilder) apply the content filter
// 3) otherwise the pagebuilder class exists (ie, we have pagebuilder > v2.5), so do not apply the content filter
if( function_exists('siteorigin_panels_filter_content') ){
remove_filter( 'the_content', 'siteorigin_panels_filter_content' );
$content = apply_filters( 'the_content', $content, 9999 );
add_filter( 'the_content', 'siteorigin_panels_filter_content' );
} elseif( !class_exists('SiteOrigin_Panels') ){
$content = apply_filters( 'the_content', $content, 9999 );
}
//now that we are done, re-add our special content filter
add_filter( 'the_content', array($gp_testimonial_class, 'single_testimonial_content_filter'), 10 );
return $content;
}
function gratavar_exists_for_email($email = '')
{
if ( empty( $email ) ) {
return false;
}
$trans_key = 'has_gravatar_' . sanitize_title($email);
$email_has_gravatar = get_transient($trans_key);
if ( !empty($email_has_gravatar) ) {
$has_valid_avatar = ( strcmp($email_has_gravatar, 'Y') == 0 );
} else {
// Craft a potential url and test its headers
$hash = md5(strtolower(trim($email)));
$uri = 'http://www.gravatar.com/avatar/' . $hash . '?d=404';
$headers = @get_headers($uri);
if (!preg_match("|200|", $headers[0])) {
$has_valid_avatar = false;
set_transient($trans_key, 'N', 86400); // one day expiration
} else {
$has_valid_avatar = true;
set_transient($trans_key, 'Y', 86400); // one day expiration
}
}
return $has_valid_avatar;
}
/*
* Returns the value of the first <img> tag encountered. If no tags present,
* empty string will be returned.
*
* @param string $html The text to search
*
* @return string The first <img> tag's src attribute's value,
* or an empty string if no <img> tags found.
*/
function extract_image_source($html)
{
$doc = new DOMDocument();
$doc->loadHTML($html);
$image_tags = $doc->getElementsByTagName('img');
if ( empty($image_tags) ) {
return '';
}
// return source of first image found
foreach($image_tags as $tag) {
return $tag->getAttribute('src');
}
// no image srcs found
return '';
}
/*
* Strips HTML comments from the provided text
*
* @param string $content The text from which to remove HTML comments
*
* @return string The text with the HTML comments removed.
*/
function remove_html_comments($content)
{
return preg_replace('/<!--(.*)-->/Uis', '', $content);
}
}// end class Testimonial