File: /var/www/vfconf/wp-content/plugins/so-widgets-bundle/widgets/image/image.php
<?php
/*
Widget Name: Image
Description: Add a responsive image with custom dimensions, positioning, caption, link, and styling options.
Author: SiteOrigin
Author URI: https://siteorigin.com
Documentation: https://siteorigin.com/widgets-bundle/image-widget-documentation/
Keywords: caption, photo
*/
class SiteOrigin_Widget_Image_Widget extends SiteOrigin_Widget {
public function __construct() {
parent::__construct(
'sow-image',
__( 'SiteOrigin Image', 'so-widgets-bundle' ),
array(
'description' => __( 'Add a responsive image with custom dimensions, positioning, caption, link, and styling options.', 'so-widgets-bundle' ),
'help' => 'https://siteorigin.com/widgets-bundle/image-widget-documentation/',
),
array(
),
false,
plugin_dir_path( __FILE__ )
);
}
public function get_settings_form() {
return array(
'responsive_breakpoint' => array(
'type' => 'measurement',
'label' => __( 'Responsive Breakpoint', 'so-widgets-bundle' ),
'default' => '780px',
'description' => __( 'Device width, in pixels, to collapse into a mobile view.', 'so-widgets-bundle' ),
),
);
}
public function get_widget_form() {
return array(
'image' => array(
'type' => 'media',
'label' => __( 'Image file', 'so-widgets-bundle' ),
'library' => 'image',
'fallback' => true,
'state_emitter' => array(
'callback' => 'conditional',
'args' => array(
'has_external_image[show]: isNaN( val )',
'has_external_image[hide]: ! isNaN( val )',
),
),
),
'size' => array(
'type' => 'image-size',
'label' => __( 'Image size', 'so-widgets-bundle' ),
'custom_size' => true,
'custom_size_enforce' => true,
),
'size_external' => array(
'type' => 'image-size',
'label' => __( 'External image size', 'so-widgets-bundle' ),
'sizes' => array(
'full' => __( 'Full', 'so-widgets-bundle' ),
),
'custom_size' => true,
'state_handler' => array(
'has_external_image[show]' => array( 'show' ),
'has_external_image[hide]' => array( 'hide' ),
),
),
'align' => array(
'type' => 'select',
'label' => __( 'Image alignment', 'so-widgets-bundle' ),
'default' => 'default',
'options' => array(
'default' => __( 'Default', 'so-widgets-bundle' ),
'left' => __( 'Left', 'so-widgets-bundle' ),
'right' => __( 'Right', 'so-widgets-bundle' ),
'center' => __( 'Center', 'so-widgets-bundle' ),
),
),
'title_align' => array(
'type' => 'select',
'label' => __( 'Title alignment', 'so-widgets-bundle' ),
'default' => 'default',
'options' => array(
'default' => __( 'Default', 'so-widgets-bundle' ),
'left' => __( 'Left', 'so-widgets-bundle' ),
'right' => __( 'Right', 'so-widgets-bundle' ),
'center' => __( 'Center', 'so-widgets-bundle' ),
),
),
'title' => array(
'type' => 'text',
'label' => __( 'Title text', 'so-widgets-bundle' ),
),
'title_position' => array(
'type' => 'select',
'label' => __( 'Title position', 'so-widgets-bundle' ),
'default' => 'hidden',
'options' => array(
'hidden' => __( 'Hidden', 'so-widgets-bundle' ),
'above' => __( 'Above', 'so-widgets-bundle' ),
'below' => __( 'Below', 'so-widgets-bundle' ),
),
),
'alt' => array(
'type' => 'text',
'label' => __( 'Alt text', 'so-widgets-bundle' ),
),
'url' => array(
'type' => 'link',
'label' => __( 'Destination URL', 'so-widgets-bundle' ),
),
'link_title' => array(
'type' => 'checkbox',
'default' => false,
'label' => __( 'Link title to URL', 'so-widgets-bundle' ),
),
'new_window' => array(
'type' => 'checkbox',
'default' => false,
'label' => __( 'Open in new window', 'so-widgets-bundle' ),
),
'bound' => array(
'type' => 'checkbox',
'default' => true,
'label' => __( 'Bound', 'so-widgets-bundle' ),
'description' => __( "Make sure the image doesn't extend beyond its container.", 'so-widgets-bundle' ),
),
'full_width' => array(
'type' => 'checkbox',
'default' => false,
'label' => __( 'Full width', 'so-widgets-bundle' ),
'description' => __( 'Resize image to fit its container.', 'so-widgets-bundle' ),
),
'rel' => array(
'type' => 'text',
'label' => __( 'Rel', 'so-widgets-bundle' ),
),
'image_shape' => array(
'type' => 'section',
'label' => __( 'Image Shape', 'so-widgets-bundle' ),
'state' => 'closed',
'fields' => array(
'enable' => array(
'type' => 'checkbox',
'label' => __( 'Enable', 'so-widgets-bundle' ),
'default' => false,
'state_emitter' => array(
'callback' => 'conditional',
'args' => array(
'image_shape[enabled]: val',
'image_shape[disabled]: ! val',
),
),
),
'shape' => array(
'type' => 'image_shape',
'label' => __( 'Image Shape', 'so-widgets-bundle' ),
'state_handler' => array(
'image_shape[enabled]' => array( 'show' ),
'image_shape[disabled]' => array( 'hide' ),
),
),
'repeat' => array(
'type' => 'select',
'label' => __( 'Repeat', 'so-widgets-bundle' ),
'options' => array(
'no-repeat' => __( 'No Repeat', 'so-widgets-bundle' ),
'repeat' => __( 'Repeat', 'so-widgets-bundle' ),
'space' => __( 'Repeat (No Clipping)', 'so-widgets-bundle' ),
'repeat-x' => __( 'Repeat Horizontally', 'so-widgets-bundle' ),
'repeat-y' => __( 'Repeat Vertically', 'so-widgets-bundle' ),
),
'state_handler' => array(
'image_shape[enabled]' => array( 'show' ),
'image_shape[disabled]' => array( 'hide' ),
),
),
'size' => array(
'type' => 'measurement',
'label' => __( 'Size', 'so-widgets-bundle' ),
'state_handler' => array(
'image_shape[enabled]' => array( 'show' ),
'image_shape[disabled]' => array( 'hide' ),
),
),
'alignment' => array(
'type' => 'select',
'label' => __( 'Alignment ', 'so-widgets-bundle' ),
'default' => 'center',
'options' => array(
'left' => __( 'Left', 'so-widgets-bundle' ),
'center' => __( 'Center', 'so-widgets-bundle' ),
'right' => __( 'Right', 'so-widgets-bundle' ),
),
'state_handler' => array(
'image_shape[enabled]' => array( 'show' ),
'image_shape[disabled]' => array( 'hide' ),
),
),
),
),
);
}
public function get_style_hash( $instance ) {
return substr( md5( serialize( $this->get_less_variables( $instance ) ) ), 0, 12 );
}
public function get_template_variables( $instance, $args ) {
$title = $this->get_image_title( $instance );
// Add support for custom sizes.
if (
$instance['size'] == 'custom_size' &&
(
! empty( $instance['size_width'] ) ||
! empty( $instance['size_height'] )
)
) {
$instance['size'] = array(
! empty( $instance['size_width'] ) ? (int) $instance['size_width'] : 0,
! empty( $instance['size_height'] ) ? (int) $instance['size_height'] : 0,
);
$custom_size = true;
}
if ( ! empty( $instance['size_external'] ) && $instance['size_external'] == 'custom_size' ) {
$external_size = array(
'width' => $instance['size_external_width'],
'height' => $instance['size_external_height'],
);
}
$src = siteorigin_widgets_get_attachment_image_src(
$instance['image'],
$instance['size'],
! empty( $instance['image_fallback'] ) ? $instance['image_fallback'] : false,
! empty( $external_size ) ? $external_size : array()
);
$attr = array();
if ( ! empty( $src ) ) {
$attr = array( 'src' => $src[0] );
if ( ! empty( $src[1] ) ) {
$attr['width'] = ! empty( $custom_size ) && ! empty( $instance['size_width'] ) ? $instance['size_width'] : $src[1];
}
if ( ! empty( $src[2] ) ) {
$attr['height'] = ! empty( $custom_size ) && ! empty( $instance['size_height'] ) ? $instance['size_height'] : $src[2];
}
if ( function_exists( 'wp_get_attachment_image_srcset' ) ) {
$attr['srcset'] = wp_get_attachment_image_srcset( $instance['image'], $instance['size'] );
}
// Don't add sizes attribute when Jetpack Photon is enabled, as it tends to have unexpected side effects.
// This was to hotfix an issue. Can remove it when we find a way to make sure output of
// `wp_get_attachment_image_sizes` is predictable with Photon enabled.
if ( ! ( class_exists( 'Jetpack_Photon' ) && Jetpack::is_module_active( 'photon' ) ) ) {
if ( function_exists( 'wp_get_attachment_image_sizes' ) ) {
$attr['sizes'] = wp_get_attachment_image_sizes( $instance['image'], $instance['size'] );
}
}
if ( ! empty( $custom_size ) && ! empty( $instance['size_enforce'] ) ) {
$attr['style'] = 'width: ' . (int) $attr['width'] . 'px; height: '. (int) $attr['height'] . 'px;';
}
}
$attr = apply_filters( 'siteorigin_widgets_image_attr', $attr, $instance, $this );
$attr['title'] = $title;
if ( ! empty( $instance['alt'] ) ) {
$attr['alt'] = $instance['alt'];
} else {
$attr['alt'] = get_post_meta( $instance['image'], '_wp_attachment_image_alt', true );
}
$attr['rel'] = ! empty( $instance['rel'] ) ? $instance['rel'] : '';
$attr = siteorigin_loading_optimization_attributes(
$attr,
'image',
$instance,
$this
);
$link_atts = array();
if ( ! empty( $instance['new_window'] ) ) {
$link_atts['target'] = '_blank';
$link_atts['rel'] = 'noopener noreferrer';
}
return apply_filters(
'siteorigin_widgets_image_args',
array(
'title' => $title,
'title_position' => $instance['title_position'],
'url' => $instance['url'],
'link_title' => ! empty( $instance['link_title'] ) ? $instance['link_title'] : false,
'new_window' => $instance['new_window'],
'link_attributes' => $link_atts,
'attributes' => $attr,
'classes' => array( 'so-widget-image' ),
),
$instance,
$this
);
}
/**
* Try to figure out an image's title for display.
*
* @return string The title of the image.
*/
private function get_image_title( $image ) {
if ( ! empty( $image['title'] ) ) {
$title = $image['title'];
} elseif ( apply_filters( 'siteorigin_widgets_auto_title', true, 'sow-image' ) ) {
$title = wp_get_attachment_caption( $image['image'] );
if ( empty( $title ) ) {
// We do not want to use the default image titles as they're based on the file name without the extension
$file_name = pathinfo( get_post_meta( $image['image'], '_wp_attached_file', true ), PATHINFO_FILENAME );
$title = get_the_title( $image['image'] );
if ( $title == $file_name ) {
$title = '';
}
}
} else {
$title = '';
}
return $title;
}
public function get_less_variables( $instance ) {
if ( empty( $instance ) ) {
return array();
}
$less_variables = array(
'title_alignment' => ! empty( $instance['title_align'] ) ? $instance['title_align'] : '',
'image_alignment' => $instance['align'],
'image_max_width' => ! empty( $instance['bound'] ) ? '100%' : '',
'image_height' => ! empty( $instance['bound'] ) ? 'auto' : '',
'image_width' => ! empty( $instance['full_width'] ) ? '100%' : '',
'size_enforce' => $instance['size'] == 'custom_size' && ! empty( $instance['size_enforce'] ),
'responsive_breakpoint' => $this->get_global_settings( 'responsive_breakpoint' ),
);
if (
! empty( $instance['image_shape'] ) &&
! empty( $instance['image_shape']['enable'] ) &&
SiteOrigin_Widget_Image_Shapes::single()->is_valid_shape( $instance['image_shape']['shape'] )
) {
$less_variables['image_shape_size'] = ! empty( $instance['image_shape']['size'] ) ? $instance['image_shape']['size'] : 'contain';
$less_variables['image_shape_repeat'] = ! empty( $instance['image_shape']['repeat'] ) ? $instance['image_shape']['repeat'] : 'no-repeat';
$less_variables['image_shape_position'] = ! empty( $instance['image_shape']['alignment'] ) ? $instance['image_shape']['alignment'] : 'center';
$less_variables['image_shape'] = 'url( "' . esc_url( SiteOrigin_Widget_Image_Shapes::single()->get_image_shape( $instance['image_shape']['shape'] ) ) . '" )';
}
return $less_variables;
}
public function generate_anchor_open( $url, $link_attributes ) {
?>
<a href="<?php echo sow_esc_url( $url ); ?>"
<?php
foreach ( $link_attributes as $attr => $val ) {
if ( ! empty( $val ) ) {
echo siteorigin_sanitize_attribute_key( $attr ) . '="' . esc_attr( $val ) . '" ';
}
}
?>
>
<?php
}
public function get_form_teaser() {
if ( class_exists( 'SiteOrigin_Premium' ) ) {
return false;
}
return array(
sprintf(
__( 'Add a Lightbox to your images with %sSiteOrigin Premium%s', 'so-widgets-bundle' ),
'<a href="https://siteorigin.com/downloads/premium/?featured_addon=plugin/lightbox" target="_blank" rel="noopener noreferrer">',
'</a>'
),
sprintf(
__( 'Add a beautiful and customizable text overlay with animations to your images with %sSiteOrigin Premium%s', 'so-widgets-bundle' ),
'<a href="https://siteorigin.com/downloads/premium/?featured_addon=plugin/image-overlay" target="_blank" rel="noopener noreferrer">',
'</a>'
),
sprintf(
__( 'Add an image title tooltip with %sSiteOrigin Premium%s', 'so-widgets-bundle' ),
'<a href="https://siteorigin.com/downloads/premium/?featured_addon=plugin/tooltip" target="_blank" rel="noopener noreferrer">',
'</a>'
),
);
}
}
siteorigin_widget_register( 'sow-image', __FILE__, 'SiteOrigin_Widget_Image_Widget' );