'widget_sp_image', 'description' => __( 'Showcase a single image link overlaid with a Description', 'image_widget' ) );
$control_ops = array( 'id_base' => 'widget_sp_image' );
$this->WP_Widget('widget_sp_image', __('TI Driver Widget', 'image_widget'), $widget_ops, $control_ops);
if ( $this->use_old_uploader() ) {
require_once( 'lib/ImageWidgetDeprecated.php' );
new ImageWidgetDeprecated( $this );
} else {
add_action( 'sidebar_admin_setup', array( $this, 'admin_setup' ) );
}
add_action( 'admin_head-widgets.php', array( $this, 'admin_head' ) );
add_action( 'plugin_row_meta', array( $this, 'plugin_row_meta' ),10 ,2 );
if ( !defined('I_HAVE_SUPPORTED_THE_IMAGE_WIDGET') )
add_action( 'admin_notices', array( $this, 'post_upgrade_nag') );
add_action( 'network_admin_notices', array( $this, 'post_upgrade_nag') );
}
/**
* Test to see if this version of WordPress supports the new image manager.
* @return bool true if the current version of WordPress does NOT support the current image management tech.
*/
private function use_old_uploader() {
if ( defined( 'IMAGE_WIDGET_COMPATIBILITY_TEST' ) ) return true;
return !function_exists('wp_enqueue_media');
}
/**
* Enqueue all the javascript.
*/
function admin_setup() {
wp_enqueue_media();
wp_enqueue_script( 'tribe-image-widget', plugins_url('resources/js/image-widget.js', __FILE__), array( 'jquery', 'media-upload', 'media-views' ), self::VERSION );
wp_localize_script( 'tribe-image-widget', 'TribeImageWidget', array(
'frame_title' => __( 'Select an Image', 'image_widget' ),
'button_title' => __( 'Insert Into Widget', 'image_widget' ),
) );
}
/**
* Widget frontend output
*
* @param array $args
* @param array $instance
* @author Modern Tribe, Inc.
*/
function widget( $args, $instance ) {
extract( $args );
$instance = wp_parse_args( (array) $instance, self::get_defaults() );
if ( !empty( $instance['imageurl'] ) || !empty( $instance['attachment_id'] ) ) {
$instance['description'] = apply_filters( 'widget_text', $instance['description'], $args, $instance );
$instance['link'] = apply_filters( 'image_widget_image_link', esc_url( $instance['link'] ), $args, $instance );
if ( !defined( 'IMAGE_WIDGET_COMPATIBILITY_TEST' ) ) {
$instance['attachment_id'] = ( $instance['attachment_id'] > 0 ) ? $instance['attachment_id'] : $instance['image'];
$instance['attachment_id'] = apply_filters( 'image_widget_image_attachment_id', abs( $instance['attachment_id'] ), $args, $instance );
}
$instance['imageurl'] = apply_filters( 'image_widget_image_url', esc_url( $instance['imageurl'] ), $args, $instance );
// No longer using extracted vars. This is here for backwards compatibility.
extract( $instance );
include( $this->getTemplateHierarchy( 'widget' ) );
}
}
/**
* Update widget options
*
* @param object $new_instance Widget Instance
* @param object $old_instance Widget Instance
* @return object
* @author Modern Tribe, Inc.
*/
function update( $new_instance, $old_instance ) {
$instance = $old_instance;
$new_instance = wp_parse_args( (array) $new_instance, self::get_defaults() );
$instance['title'] = strip_tags($new_instance['title']);
if ( current_user_can('unfiltered_html') ) {
$instance['description'] = $new_instance['description'];
} else {
$instance['description'] = wp_filter_post_kses($new_instance['description']);
}
$instance['link'] = $new_instance['link'];
$instance['linktarget'] = $new_instance['linktarget'];
$instance['width'] = abs( $new_instance['width'] );
$instance['height'] =abs( $new_instance['height'] );
if ( !defined( 'IMAGE_WIDGET_COMPATIBILITY_TEST' ) ) {
$instance['size'] = $new_instance['size'];
}
$instance['align'] = $new_instance['align'];
$instance['alt'] = $new_instance['alt'];
// Reverse compatibility with $image, now called $attachement_id
if ( !defined( 'IMAGE_WIDGET_COMPATIBILITY_TEST' ) && $new_instance['attachment_id'] > 0 ) {
$instance['attachment_id'] = abs( $new_instance['attachment_id'] );
} elseif ( $new_instance['image'] > 0 ) {
$instance['attachment_id'] = $instance['image'] = abs( $new_instance['image'] );
if ( class_exists('ImageWidgetDeprecated') ) {
$instance['imageurl'] = ImageWidgetDeprecated::get_image_url( $instance['image'], $instance['width'], $instance['height'] ); // image resizing not working right now
}
}
$instance['imageurl'] = $new_instance['imageurl']; // deprecated
$instance['aspect_ratio'] = $this->get_image_aspect_ratio( $instance );
return $instance;
}
/**
* Form UI
*
* @param object $instance Widget Instance
* @author Modern Tribe, Inc.
*/
function form( $instance ) {
$instance = wp_parse_args( (array) $instance, self::get_defaults() );
if ( $this->use_old_uploader() ) {
include( $this->getTemplateHierarchy( 'widget-admin.deprecated' ) );
} else {
include( $this->getTemplateHierarchy( 'widget-admin' ) );
}
}
/**
* Admin header css
*
* @author Modern Tribe, Inc.
*/
function admin_head() {
?>
'',
'description' => '',
'link' => '',
'linktarget' => '',
'width' => 0,
'height' => 0,
'image' => 0, // reverse compatible - now attachement_id
'imageurl' => '', // reverse compatible.
'align' => 'none',
'alt' => '',
);
if ( !defined( 'IMAGE_WIDGET_COMPATIBILITY_TEST' ) ) {
$defaults['size'] = self::CUSTOM_IMAGE_SIZE_SLUG;
$defaults['attachment_id'] = 0;
}
return $defaults;
}
/**
* Render the image html output.
*
* @param array $instance
* @param bool $include_link will only render the link if this is set to true. Otherwise link is ignored.
* @return string image html
*/
private function get_image_html( $instance, $include_link = true ) {
// Backwards compatible image display.
if ( $instance['attachment_id'] == 0 && $instance['image'] > 0 ) {
$instance['attachment_id'] = $instance['image'];
}
$output = '';
if ( $include_link && !empty( $instance['link'] ) ) {
$attr = array(
'href' => $instance['link'],
'target' => $instance['linktarget'],
'class' => $this->widget_options['classname'].'-image-link',
'title' => ( !empty( $instance['alt'] ) ) ? $instance['alt'] : $instance['title'],
);
$attr = apply_filters('image_widget_link_attributes', $attr, $instance );
$attr = array_map( 'esc_attr', $attr );
$output = ' $value ) {
$output .= sprintf( ' %s="%s"', $name, $value );
}
$output .= '>';
}
$size = $this->get_image_size( $instance );
if ( is_array( $size ) ) {
$instance['width'] = $size[0];
$instance['height'] = $size[1];
} elseif ( !empty( $instance['attachment_id'] ) ) {
//$instance['width'] = $instance['height'] = 0;
$image_details = wp_get_attachment_image_src( $instance['attachment_id'], $size );
if ($image_details) {
$instance['imageurl'] = $image_details[0];
$instance['width'] = $image_details[1];
$instance['height'] = $image_details[2];
}
}
$instance['width'] = abs( $instance['width'] );
$instance['height'] = abs( $instance['height'] );
$attr = array();
$attr['alt'] = $instance['title'];
if (is_array($size)) {
$attr['class'] = 'attachment-'.join('x',$size);
} else {
$attr['class'] = 'attachment-'.$size;
}
$attr['style'] = '';
if (!empty($instance['width'])) {
$attr['style'] .= "max-width: {$instance['width']}px;";
}
if (!empty($instance['height'])) {
$attr['style'] .= "max-height: {$instance['height']}px;";
}
if (!empty($instance['align']) && $instance['align'] != 'none') {
$attr['class'] .= " align{$instance['align']}";
}
$attr = apply_filters( 'image_widget_image_attributes', $attr, $instance );
// If there is an imageurl, use it to render the image. Eventually we should kill this and simply rely on attachment_ids.
if ( !empty( $instance['imageurl'] ) ) {
// If all we have is an image src url we can still render an image.
$attr['src'] = $instance['imageurl'];
$attr = array_map( 'esc_attr', $attr );
$hwstring = image_hwstring( $instance['width'], $instance['height'] );
$output .= rtrim("![]()
$value ) {
$output .= sprintf( ' %s="%s"', $name, $value );
}
$output .= ' />';
} elseif( abs( $instance['attachment_id'] ) > 0 ) {
$output .= wp_get_attachment_image($instance['attachment_id'], $size, false, $attr);
}
if ( $include_link && !empty( $instance['link'] ) ) {
$output .= '';
}
return $output;
}
/**
* Assesses the image size in case it has not been set or in case there is a mismatch.
*
* @param $instance
* @return array|string
*/
private function get_image_size( $instance ) {
//if ( !empty( $instance['size'] ) && $instance['size'] != self::CUSTOM_IMAGE_SIZE_SLUG ) {
//$size = $instance['size'];
//} elseif ( isset( $instance['width'] ) && is_numeric($instance['width']) && isset( $instance['height'] ) && is_numeric($instance['height']) ) {
//$size = array(abs($instance['width']),abs($instance['height']));
//} else {
//$size = 'full';
//}
// TI override
//$size = array(abs($instance['width']),abs($instance['height']));
$size = 'event';
return $size;
}
/**
* Establish the aspect ratio of the image.
*
* @param $instance
* @return float|number
*/
private function get_image_aspect_ratio( $instance ) {
if ( !empty( $instance['aspect_ratio'] ) ) {
return abs( $instance['aspect_ratio'] );
} else {
$attachment_id = ( !empty($instance['attachment_id']) ) ? $instance['attachment_id'] : $instance['image'];
if ( !empty($attachment_id) ) {
$image_details = wp_get_attachment_image_src( $attachment_id, 'full' );
if ($image_details) {
return ( $image_details[1]/$image_details[2] );
}
}
}
}
/**
* Loads theme files in appropriate hierarchy: 1) child theme,
* 2) parent template, 3) plugin resources. will look in the image-widget/
* directory in a theme and the views/ directory in the plugin
*
* @param string $template template file to search for
* @return template path
* @author Modern Tribe, Inc. (Matt Wiebe)
**/
function getTemplateHierarchy($template) {
// whether or not .php was added
$template_slug = rtrim($template, '.php');
$template = $template_slug . '.php';
if ( $theme_file = locate_template(array('image-widget/'.$template)) ) {
$file = $theme_file;
} else {
$file = 'views/' . $template;
}
return apply_filters( 'sp_template_image-widget_'.$template, $file);
}
/**
* Display a thank you nag when the plugin has been upgraded.
*/
public function post_upgrade_nag() {
if ( !current_user_can('install_plugins') ) return;
$version_key = '_image_widget_version';
if ( get_site_option( $version_key ) == self::VERSION ) return;
$msg = sprintf(__('Thanks for upgrading the Image Widget! If you like this plugin, please consider rating it and maybe even check out our premium plugins including our Events Calendar Pro!', 'image-widget'),'http://wordpress.org/extend/plugins/image-widget/?source=image-widget&pos=nag','http://tri.be/wordpress-events-calendar-pro/?source=image-widget&pos=nag');
// echo "$msg
";
update_site_option( $version_key, self::VERSION );
}
/**
* Display an informational section in the plugin admin ui.
* @param $meta
* @param $file
*
* @return array
*/
public function plugin_row_meta( $meta, $file ) {
if ( $file == plugin_basename( dirname(__FILE__).'/image-widget.php' ) ) {
$meta[] = ''.sprintf(__('Check out our other plugins including our Events Calendar Pro!', 'image-widget'),'http://tri.be/products/?source=image-widget&pos=pluginlist','http://tri.be/wordpress-events-calendar-pro/?source=image-widget&pos=pluginlist').'';
}
return $meta;
}
}