| 1 |
<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName |
| 2 |
/** |
| 3 |
* Module Name: Image Widget |
| 4 |
* Module Description: Easily add images to your theme's sidebar. |
| 5 |
* Sort Order: 20 |
| 6 |
* First Introduced: 1.2 |
| 7 |
*/ |
| 8 |
|
| 9 |
// phpcs:disable Universal.Files.SeparateFunctionsFromOO.Mixed -- TODO: Move classes to appropriately-named class files. |
| 10 |
|
| 11 |
add_action( 'widgets_init', 'jetpack_image_widget_init', 11 ); |
| 12 |
/** |
| 13 |
* Register the widget for use in Appearance -> Widgets |
| 14 |
*/ |
| 15 |
function jetpack_image_widget_init() { |
| 16 |
if ( class_exists( 'WP_Widget_Media_Image' ) && Jetpack_Options::get_option( 'image_widget_migration' ) ) { |
| 17 |
return; |
| 18 |
} |
| 19 |
register_widget( 'Jetpack_Image_Widget' ); |
| 20 |
} |
| 21 |
|
| 22 |
/** |
| 23 |
* Jetpack_Image_Widget main class. |
| 24 |
*/ |
| 25 |
class Jetpack_Image_Widget extends WP_Widget { |
| 26 |
/** |
| 27 |
* Register widget with WordPress. |
| 28 |
*/ |
| 29 |
public function __construct() { |
| 30 |
parent::__construct( |
| 31 |
'image', |
| 32 |
/** This filter is documented in modules/widgets/facebook-likebox.php */ |
| 33 |
apply_filters( 'jetpack_widget_name', esc_html__( 'Image', 'jetpack' ) ), |
| 34 |
array( |
| 35 |
'classname' => 'widget_image', |
| 36 |
'description' => __( 'Display an image in your sidebar', 'jetpack' ), |
| 37 |
'customize_selective_refresh' => true, |
| 38 |
) |
| 39 |
); |
| 40 |
|
| 41 |
if ( is_active_widget( false, false, $this->id_base ) || is_active_widget( false, false, 'monster' ) || is_customize_preview() ) { |
| 42 |
add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_style' ) ); |
| 43 |
} |
| 44 |
} |
| 45 |
|
| 46 |
/** |
| 47 |
* Loads file for front-end widget style. |
| 48 |
* |
| 49 |
* @uses wp_enqueue_style(), plugins_url() |
| 50 |
*/ |
| 51 |
public function enqueue_style() { |
| 52 |
wp_enqueue_style( 'jetpack_image_widget', plugins_url( 'image-widget/style.css', __FILE__ ), array(), '20140808' ); |
| 53 |
} |
| 54 |
|
| 55 |
/** |
| 56 |
* Front-end display of widget. |
| 57 |
* |
| 58 |
* @see WP_Widget::widget() |
| 59 |
* |
| 60 |
* @param array $args Widget arguments. |
| 61 |
* @param array $instance Saved values from database. |
| 62 |
*/ |
| 63 |
public function widget( $args, $instance ) { |
| 64 |
echo $args['before_widget']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped |
| 65 |
|
| 66 |
$instance = wp_parse_args( |
| 67 |
$instance, |
| 68 |
array( |
| 69 |
'title' => '', |
| 70 |
'img_url' => '', |
| 71 |
) |
| 72 |
); |
| 73 |
|
| 74 |
/** This filter is documented in core/src/wp-includes/default-widgets.php */ |
| 75 |
$title = apply_filters( 'widget_title', $instance['title'] ); |
| 76 |
if ( $title ) { |
| 77 |
echo $args['before_title'] . $title . $args['after_title']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped |
| 78 |
} |
| 79 |
|
| 80 |
if ( $instance['img_url'] ) { |
| 81 |
|
| 82 |
$output = '<img src="' . esc_url( $instance['img_url'] ) . '" '; |
| 83 |
|
| 84 |
if ( '' !== (string) $instance['alt_text'] ) { |
| 85 |
$output .= 'alt="' . esc_attr( $instance['alt_text'] ) . '" '; |
| 86 |
} |
| 87 |
if ( '' !== (string) $instance['img_title'] ) { |
| 88 |
$output .= 'title="' . esc_attr( $instance['img_title'] ) . '" '; |
| 89 |
} |
| 90 |
if ( '' !== (string) $instance['caption'] ) { |
| 91 |
$output .= 'class="align' . esc_attr( $instance['align'] ) . '" '; |
| 92 |
} |
| 93 |
if ( '' !== (string) $instance['img_width'] ) { |
| 94 |
$output .= 'width="' . esc_attr( $instance['img_width'] ) . '" '; |
| 95 |
} |
| 96 |
if ( '' !== (string) $instance['img_height'] ) { |
| 97 |
$output .= 'height="' . esc_attr( $instance['img_height'] ) . '" '; |
| 98 |
} |
| 99 |
$output .= '/>'; |
| 100 |
|
| 101 |
if ( class_exists( 'Jetpack_Photon' ) && Jetpack::is_module_active( 'photon' ) ) { |
| 102 |
$output = Jetpack_Photon::filter_the_content( $output ); |
| 103 |
} |
| 104 |
|
| 105 |
if ( $instance['link'] ) { |
| 106 |
$target = ! empty( $instance['link_target_blank'] ) |
| 107 |
? 'target="_blank"' |
| 108 |
: ''; |
| 109 |
$output = '<a ' . $target . ' href="' . esc_url( $instance['link'] ) . '">' . $output . '</a>'; |
| 110 |
} |
| 111 |
if ( '' !== (string) $instance['caption'] ) { |
| 112 |
/** This filter is documented in core/src/wp-includes/default-widgets.php */ |
| 113 |
$caption = apply_filters( 'widget_text', $instance['caption'] ); |
| 114 |
$img_width = ( ! empty( $instance['img_width'] ) ? 'style="width: ' . esc_attr( $instance['img_width'] ) . 'px"' : '' ); |
| 115 |
$output = '<figure ' . $img_width . ' class="wp-caption align' . esc_attr( $instance['align'] ) . '"> |
| 116 |
' . $output . ' |
| 117 |
<figcaption class="wp-caption-text">' . $caption . '</figcaption> |
| 118 |
</figure>'; // wp_kses_post caption on update. |
| 119 |
} |
| 120 |
echo '<div class="jetpack-image-container">' . do_shortcode( $output ) . '</div>'; |
| 121 |
} elseif ( current_user_can( 'edit_theme_options' ) ) { |
| 122 |
echo '<p>' . wp_kses( |
| 123 |
sprintf( |
| 124 |
/* translators: %s link to the widget settings page. */ |
| 125 |
__( 'Image missing or invalid URL. Please check the Image widget URL in your <a href="%s">widget settings</a>.', 'jetpack' ), |
| 126 |
admin_url( 'widgets.php' ) |
| 127 |
), |
| 128 |
array( |
| 129 |
'a' => array( |
| 130 |
'href' => array(), |
| 131 |
), |
| 132 |
) |
| 133 |
) . '</p>'; |
| 134 |
} |
| 135 |
|
| 136 |
echo "\n" . $args['after_widget']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped |
| 137 |
|
| 138 |
/** This action is documented in modules/widgets/gravatar-profile.php */ |
| 139 |
do_action( 'jetpack_stats_extra', 'widget_view', 'image' ); |
| 140 |
} |
| 141 |
|
| 142 |
/** |
| 143 |
* Sanitize widget form values as they are saved. |
| 144 |
* |
| 145 |
* @see WP_Widget::update() |
| 146 |
* |
| 147 |
* @param array $new_instance Values just sent to be saved. |
| 148 |
* @param array $old_instance Previously saved values from database. |
| 149 |
* |
| 150 |
* @return array Updated safe values to be saved. |
| 151 |
*/ |
| 152 |
public function update( $new_instance, $old_instance ) { |
| 153 |
$allowed_caption_html = array( |
| 154 |
'a' => array( |
| 155 |
'href' => array(), |
| 156 |
'title' => array(), |
| 157 |
), |
| 158 |
'b' => array(), |
| 159 |
'em' => array(), |
| 160 |
'i' => array(), |
| 161 |
'p' => array(), |
| 162 |
'strong' => array(), |
| 163 |
); |
| 164 |
|
| 165 |
$instance = $old_instance; |
| 166 |
|
| 167 |
$instance['title'] = wp_strip_all_tags( $new_instance['title'] ); |
| 168 |
$instance['img_url'] = esc_url( trim( $new_instance['img_url'] ) ); |
| 169 |
$instance['alt_text'] = wp_strip_all_tags( $new_instance['alt_text'] ); |
| 170 |
$instance['img_title'] = wp_strip_all_tags( $new_instance['img_title'] ); |
| 171 |
$instance['caption'] = wp_kses( stripslashes( $new_instance['caption'] ), $allowed_caption_html ); |
| 172 |
$instance['align'] = $new_instance['align']; |
| 173 |
$instance['link'] = esc_url( trim( $new_instance['link'] ) ); |
| 174 |
$instance['link_target_blank'] = isset( $new_instance['link_target_blank'] ) ? (bool) $new_instance['link_target_blank'] : false; |
| 175 |
|
| 176 |
$new_img_width = absint( $new_instance['img_width'] ); |
| 177 |
$new_img_height = absint( $new_instance['img_height'] ); |
| 178 |
|
| 179 |
if ( ! empty( $instance['img_url'] ) && 0 === $new_img_width && 0 === $new_img_height ) { |
| 180 |
// Download the url to a local temp file and then process it with getimagesize so we can optimize browser layout. |
| 181 |
$tmp_file = download_url( $instance['img_url'], 10 ); |
| 182 |
if ( ! is_wp_error( $tmp_file ) ) { |
| 183 |
$size = getimagesize( $tmp_file ); |
| 184 |
|
| 185 |
$width = $size[0]; |
| 186 |
$instance['img_width'] = absint( $width ); |
| 187 |
|
| 188 |
$height = $size[1]; |
| 189 |
$instance['img_height'] = absint( $height ); |
| 190 |
|
| 191 |
wp_delete_file( $tmp_file ); |
| 192 |
} else { |
| 193 |
$instance['img_width'] = $new_img_width; |
| 194 |
$instance['img_height'] = $new_img_height; |
| 195 |
} |
| 196 |
} else { |
| 197 |
$instance['img_width'] = $new_img_width; |
| 198 |
$instance['img_height'] = $new_img_height; |
| 199 |
} |
| 200 |
|
| 201 |
return $instance; |
| 202 |
} |
| 203 |
|
| 204 |
/** |
| 205 |
* Back end widget form. |
| 206 |
* |
| 207 |
* @see WP_Widget::form() |
| 208 |
* |
| 209 |
* @param array $instance Previously saved values from database. |
| 210 |
*/ |
| 211 |
public function form( $instance ) { |
| 212 |
// Defaults. |
| 213 |
$instance = wp_parse_args( |
| 214 |
(array) $instance, |
| 215 |
array( |
| 216 |
'title' => '', |
| 217 |
'img_url' => '', |
| 218 |
'alt_text' => '', |
| 219 |
'img_title' => '', |
| 220 |
'caption' => '', |
| 221 |
'align' => 'none', |
| 222 |
'img_width' => '', |
| 223 |
'img_height' => '', |
| 224 |
'link' => '', |
| 225 |
'link_target_blank' => false, |
| 226 |
) |
| 227 |
); |
| 228 |
|
| 229 |
$title = esc_attr( $instance['title'] ); |
| 230 |
$img_url = esc_url( $instance['img_url'], null, 'display' ); |
| 231 |
$alt_text = esc_attr( $instance['alt_text'] ); |
| 232 |
$img_title = esc_attr( $instance['img_title'] ); |
| 233 |
$caption = esc_textarea( $instance['caption'] ); |
| 234 |
$align = esc_attr( $instance['align'] ); |
| 235 |
$img_width = esc_attr( $instance['img_width'] ); |
| 236 |
$img_height = esc_attr( $instance['img_height'] ); |
| 237 |
$link_target_blank = checked( $instance['link_target_blank'], true, false ); |
| 238 |
|
| 239 |
$link = esc_url( $instance['link'], null, 'display' ); |
| 240 |
|
| 241 |
echo '<p><label for="' . esc_attr( $this->get_field_id( 'title' ) ) . '">' . esc_html__( 'Widget title:', 'jetpack' ) . ' |
| 242 |
<input class="widefat" id="' . esc_attr( $this->get_field_id( 'title' ) ) . '" name="' . esc_attr( $this->get_field_name( 'title' ) ) . '" type="text" value="' . esc_attr( $title ) . '" /> |
| 243 |
</label></p> |
| 244 |
<p><label for="' . esc_attr( $this->get_field_id( 'img_url' ) ) . '">' . esc_html__( 'Image URL:', 'jetpack' ) . ' |
| 245 |
<input class="widefat" id="' . esc_attr( $this->get_field_id( 'img_url' ) ) . '" name="' . esc_attr( $this->get_field_name( 'img_url' ) ) . '" type="text" value="' . esc_attr( $img_url ) . '" /> |
| 246 |
</label></p> |
| 247 |
<p><label for="' . esc_attr( $this->get_field_id( 'alt_text' ) ) . '">' . esc_html__( 'Alternate text:', 'jetpack' ) . ' <a href="https://support.wordpress.com/widgets/image-widget/#image-widget-alt-text" target="_blank">( ? )</a> |
| 248 |
<input class="widefat" id="' . esc_attr( $this->get_field_id( 'alt_text' ) ) . '" name="' . esc_attr( $this->get_field_name( 'alt_text' ) ) . '" type="text" value="' . esc_attr( $alt_text ) . '" /> |
| 249 |
</label></p> |
| 250 |
<p><label for="' . esc_attr( $this->get_field_id( 'img_title' ) ) . '">' . esc_html__( 'Image title:', 'jetpack' ) . ' <a href="https://support.wordpress.com/widgets/image-widget/#image-widget-title" target="_blank">( ? )</a> |
| 251 |
<input class="widefat" id="' . esc_attr( $this->get_field_id( 'img_title' ) ) . '" name="' . esc_attr( $this->get_field_name( 'img_title' ) ) . '" type="text" value="' . esc_attr( $img_title ) . '" /> |
| 252 |
</label></p> |
| 253 |
<p><label for="' . esc_attr( $this->get_field_id( 'caption' ) ) . '">' . esc_html__( 'Caption:', 'jetpack' ) . ' <a href="https://support.wordpress.com/widgets/image-widget/#image-widget-caption" target="_blank">( ? )</a> |
| 254 |
<textarea class="widefat" id="' . esc_attr( $this->get_field_id( 'caption' ) ) . '" name="' . esc_attr( $this->get_field_name( 'caption' ) ) . '" rows="2" cols="20">' . esc_textarea( $caption ) . '</textarea> |
| 255 |
</label></p>'; |
| 256 |
|
| 257 |
$alignments = array( |
| 258 |
'none' => __( 'None', 'jetpack' ), |
| 259 |
'left' => __( 'Left', 'jetpack' ), |
| 260 |
'center' => __( 'Center', 'jetpack' ), |
| 261 |
'right' => __( 'Right', 'jetpack' ), |
| 262 |
); |
| 263 |
echo '<p><label for="' . esc_attr( $this->get_field_id( 'align' ) ) . '">' . esc_html__( 'Image Alignment:', 'jetpack' ) . ' |
| 264 |
<select id="' . esc_attr( $this->get_field_id( 'align' ) ) . '" name="' . esc_attr( $this->get_field_name( 'align' ) ) . '">'; |
| 265 |
foreach ( $alignments as $alignment => $alignment_name ) { |
| 266 |
echo '<option value="' . esc_attr( $alignment ) . '" '; |
| 267 |
if ( $alignment === $align ) { |
| 268 |
echo 'selected="selected" '; |
| 269 |
} |
| 270 |
echo '>' . esc_html( $alignment_name ) . "</option>\n"; |
| 271 |
} |
| 272 |
echo '</select></label></p>'; |
| 273 |
|
| 274 |
echo '<p><label for="' . esc_attr( $this->get_field_id( 'img_width' ) ) . '">' . esc_html__( 'Width in pixels:', 'jetpack' ) . ' |
| 275 |
<input size="3" id="' . esc_attr( $this->get_field_id( 'img_width' ) ) . '" name="' . esc_attr( $this->get_field_name( 'img_width' ) ) . '" type="text" value="' . esc_attr( $img_width ) . '" /> |
| 276 |
</label> |
| 277 |
<label for="' . esc_attr( $this->get_field_id( 'img_height' ) ) . '">' . esc_html__( 'Height in pixels:', 'jetpack' ) . ' |
| 278 |
<input size="3" id="' . esc_attr( $this->get_field_id( 'img_height' ) ) . '" name="' . esc_attr( $this->get_field_name( 'img_height' ) ) . '" type="text" value="' . esc_attr( $img_height ) . '" /> |
| 279 |
</label><br /> |
| 280 |
<small>' . esc_html__( 'If empty, we will attempt to determine the image size.', 'jetpack' ) . '</small></p> |
| 281 |
<p><label for="' . esc_attr( $this->get_field_id( 'link' ) ) . '">' . esc_html__( 'Link URL (when the image is clicked):', 'jetpack' ) . ' |
| 282 |
<input class="widefat" id="' . esc_attr( $this->get_field_id( 'link' ) ) . '" name="' . esc_attr( $this->get_field_name( 'link' ) ) . '" type="text" value="' . esc_attr( $link ) . '" /> |
| 283 |
</label> |
| 284 |
<label for="' . esc_attr( $this->get_field_id( 'link_target_blank' ) ) . '"> |
| 285 |
<input type="checkbox" name="' . esc_attr( $this->get_field_name( 'link_target_blank' ) ) . '" id="' . esc_attr( $this->get_field_id( 'link_target_blank' ) ) . '" value="1"' . esc_attr( $link_target_blank ) . '/> |
| 286 |
' . esc_html__( 'Open link in a new window/tab', 'jetpack' ) . ' |
| 287 |
</label></p>'; |
| 288 |
} |
| 289 |
} // Class Jetpack_Image_Widget |
| 290 |
|
