PluginProbe ʕ •ᴥ•ʔ
Image Widget / trunk
Image Widget vtrunk
trunk 1.0 2.0 2.1 2.2 2.2.1 2.2.2 3.0 3.0.1 3.0.2 3.0.3 3.0.4 3.0.5 3.0.6 3.0.7 3.0.8 3.0.9 3.1 3.1.1 3.1.2 3.1.3 3.1.4 3.1.5 3.1.6 3.2 3.2.1 3.2.10 3.2.11 3.2.2 3.2.3 3.2.4 3.2.5 3.2.7 3.2.8 3.2.9 3.3 3.3.1 3.3.2 3.3.3 3.3.4 3.3.5 3.3.6 3.3.7 4.0 4.0.1 4.0.2 4.0.3 4.0.4 4.0.5 4.0.6 4.0.7 4.0.8 4.0.9 4.1 4.1.1 4.1.2 4.2 4.2.1 4.2.2 4.3 4.3.1 4.4 4.4.1 4.4.11 4.4.12 4.4.2 4.4.3 4.4.4 4.4.5 4.4.6 4.4.7 4.4.8 4.4.9
image-widget / readme.txt
image-widget Last commit date
readme.txt 2 months ago
readme.txt
565 lines
1 === Image Widget ===
2 Contributors: theeventscalendar, aguseo, borkweb, bordoni, brianjessee, leahkoerper, lucatume, neillmcshea, vicskf, zbtirrell
3 Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=4BSPTNFFY6AL6
4 Tags: widget, image, ad, banner, sidebar
5 Requires at least: 3.5
6 Tested up to: 6.7.1
7 Stable tag: 4.4.12
8
9 A simple image widget that uses the native WordPress media manager to add image widgets to your site.
10
11 == Description ==
12
13 Image Widget is a simple plugin that uses the native WordPress media manager to add image widgets to your site.
14
15 = Image Widget Features =
16
17 * Responsive
18 * MU Compatible
19 * Handles image resizing and alignment
20 * Link the image
21 * Add title and description
22 * Versatile - all fields are optional
23 * Upload, link to external image, or select an image from your media collection
24 * Customize the look & feel with filter hooks or theme overrides
25
26 = Quality You Can Trust =
27
28 Image Widget is developed and maintained by [The Events Calendar](https://evnt.is/1aor), the same folks behind [The Events Calendar, Event Tickets, and a full suite of premium plugins](https://evnt.is/19me).
29
30 This plugin is actively supported by our team and contributions from community members. If you see a question in the forum you can help with or have a great idea and want to code it up or submit a patch, that would be awesome! Not only will we shower you with praise and thanks, it’s also a good way to get to know us and lead into options for paid work if you freelance.
31
32 = Pull Requests & Translations =
33
34 [Check us out on GitHub](https://github.com/the-events-calendar/image-widget) to pull request changes.
35
36 Translations can be submitted [here on WordPress.org](https://translate.wordpress.org/projects/wp-plugins/image-widget).
37
38 == Installation ==
39
40 = Install =
41
42 Getting started with Image Widget is a breeze!
43
44 1. Download and install the Image Widget plugin
45 1. From your WordPress admin screen, select Plugins from the menu
46 1. Activate the Image Widget plugin
47 1. Go to Appearance > Widget to place the widget in your sidebar in the Design
48
49 If you run into any questions or have suggestions, please visit the forum to post questions or comments.
50
51 = Requirements =
52
53 * PHP 5.2 or above
54 * WordPress 3.5 or above
55
56 == Screenshots ==
57
58 1. Image Widget admin screen.
59 1. Media manager integration.
60 1. Image Widget on the front of a plain WordPress install.
61
62 == Frequently Asked Questions ==
63
64 = How do I log into my site to install this plugin? =
65
66 Visit [the WordPress codex](https://codex.wordpress.org/Login_Trouble) for help with login troubles.
67
68 = Can I display Image Widget on only one page? =
69
70 Yes you can, however, this is not controlled through the Image Widget plugin directly - it is usually managed through a page-specific sidebar display.
71
72 There are several solutions available to accomplish this. A quick search for “WordPress page-specific sidebar display” can help you find the best option for your site.
73
74 = Is there a demo available? =
75
76 Though we do not have a demo available, we do have [screenshots available here](https://wordpress.org/plugins/image-widget/screenshots/).
77
78 = How can I add lightbox, slider, or random image capabilities? =
79
80 These features are part of our Image Widget Plus plugin. You can learn more about [Image Widget Plus](https://evnt.is/19mh) on our website.
81
82 = Where do I go to file a bug or ask a question? =
83
84 Please [visit the forum to post questions or comments](https://wordpress.org/support/plugin/image-widget/).
85
86 = Found a security vulnerability? =
87
88 Make sure you are reporting in a safe and responsible way. We take security very seriously. If you discover a security issue, please bring it to our attention right away! Below you will find all the methods to report security vulnerabilities:
89
90 * [Report security bugs through the Patchstack Vulnerability Disclosure Program](https://patchstack.com/database/vdp/image-widget)
91 * Check our [Bug Bounty Program](https://www.liquidweb.com/policies/bug-bounty-program/)
92 * Reach out directly to us on `security [at] stellarwp.com`.
93
94 == Documentation ==
95
96 The built in template can be overridden by files within your template.
97
98 = Default vs. Custom Templates =
99
100 The Image Widget comes with a default template for the widget output. If you would like to alter the widget display code, create a new folder called "image-widget" in your template directory and copy over the "views/widget.php" file.
101
102 Edit the new file to your hearts content. Please do not edit the one in the plugin folder as that will cause conflicts when you update the plugin to the latest release.
103
104 New in 3.2: You may now also use the "sp_template_image-widget_widget.php" filter to override the default template behavior for .php template files. Eg: if you wanted widget.php to reside in a folder called my-custom-templates/ and wanted it to be called my-custom-name.php:
105
106 `add_filter('sp_template_image-widget_widget.php', 'my_template_filter');
107 function my_template_filter($template) {
108 return get_template_directory() . '/my-custom-templates/my-custom-name.php';
109 }`
110
111 = Filters =
112
113 There are a number of filters in the code that will allow you to override data as you see fit. The best way to learn what filters are available is always by simply searching the code for 'apply_filters'. But all the same, here are a few of the more essential filters:
114
115 *widget_title*
116
117 This is actually a pretty typical filter in widgets and is applied to the widget title.
118
119 *widget_text*
120
121 Another very typical widget filter that is applied to the description body text. This filter also takes 2 additional arguments for $args and $instance so that you can learn more about the specific widget instance in the process of filtering the content.
122
123 *image_widget_image_attachment_id*
124
125 Filters the attachment id of the image.
126 Accepts additional $args and $instance arguments.
127
128 *image_widget_image_url*
129
130 Filters the url of the image displayed in the widget.
131 Accepts additional $args and $instance arguments.
132 THIS IS DEPRECATED AND WILL EVENTUALLY BE DELETED
133
134 *image_widget_image_width*
135
136 Filters the display width of the image.
137 Accepts additional $args and $instance arguments.
138
139 *image_widget_image_height*
140
141 Filters the display height of the image.
142 Accepts additional $args and $instance arguments.
143
144 *image_widget_image_maxwidth*
145
146 Filters the inline max-width style of the image. Hint: override this to use this in responsive designs :)
147 Accepts additional $args and $instance arguments.
148 Return null to remove this css from the image output (defaults to '100%').
149
150 *image_widget_image_maxheight*
151
152 Filters the inline max-height style of the image.
153 Accepts additional $args and $instance arguments.
154 Return null to remove this css from the image output (defaults to null)
155
156 *image_widget_image_size*
157
158 Filters the selected image 'size' corresponding to WordPress registered sizes.
159 If this is set to 'tribe_image_widget_custom' then the width and height are used instead.
160 Accepts additional $args and $instance arguments.
161
162 *image_widget_image_align*
163
164 Filters the display alignment of the image.
165 Accepts additional $args and $instance arguments.
166
167 *image_widget_image_alt*
168
169 Filters the alt text of the image.
170 Accepts additional $args and $instance arguments.
171
172 *image_widget_image_link*
173
174 Filters the url that the image links to.
175 Accepts additional $args and $instance arguments.
176
177 *image_widget_image_link_target*
178
179 Filters the link target of the image link.
180 Accepts additional $args and $instance arguments.
181
182 *image_widget_image_attributes*
183
184 Filters a list of image attributes used in the image output. Similar to 'wp_get_attachment_image_attributes'
185 Accepts $instance arguments
186
187 *image_widget_link_attributes*
188
189 Filters a list of attributes used in the image link. Similar to 'wp_get_attachment_image_attributes'
190 Accepts $instance arguments
191
192 = Have You Supported the Image Widget? =
193
194 If so, then THANK YOU! Also, feel free to add this line to your wp-config.php file to prevent the image widget from displaying a message after upgrades.
195
196 define( 'I_HAVE_SUPPORTED_THE_IMAGE_WIDGET', true );
197
198 For more info on the philosophy here, check out our [blog post](http://tri.be/define-i-have-donated-true/)
199
200 == Changelog ==
201
202 = [4.4.12] 2026-04-20 =
203
204 * Security - Add escaping to image attributes.
205
206 = [4.4.11] 2024-11-20 =
207
208 * Security - Prevent old Image URL from being misused for XSS attacks.
209
210 = [4.4.10] 2023-05-30 =
211
212 * Fix - Prevent weird bugs around `widget_title` not having all the expected arguments.
213 * Tweak - Add documentation for a few filters.
214
215 = [4.4.9] 2022-06-05 =
216
217 * Tweak - Updating WordPress compatibility, tested up to 6.6.2.
218 * Tweak - Remove references to Image Widget Plus and Notices.
219
220 = [4.4.8] 2022-05-06 =
221
222 * Tweak - Updating WordPress compatibility.
223
224 = [4.4.7] 2017-11-02 =
225
226 * Feature - Added new Link Title field and filter to improve tooltip (previously used alt text) (thanks @marklcm) [89993]
227 * Tweak - Added new `image_widget_option_defaults` hook to improve customizability (props @svandragt) [#91225]
228
229 = [4.4.6] 2017-09-12 =
230
231 * New - Added new filter `tribe_image_widget_instance_description` for more control over how the description field is handled.
232 * Fix - Prevent broken HTML in the "description" field that sometimes arose with certain user roles. Props to users @bridgetashley and @JoshRoy spotting this one!
233
234 = [4.4.5] 2017-06-14 =
235
236 * Fix issue with image URLs in the widget admin interface [80659]
237
238 = [4.4.4] 2017-06-01 =
239
240 * Tweak - Improve upsell notices display logic [78676]
241
242 = 4.4.3 =
243
244 * Fix - Fixed bug where selecting an image failed to trigger a Save & Publish in the Customizer (props to dsaric-dev for the fix)
245 * Tweak - Roll-back to sidebar_admin_setup to enqueue resources for optimal plugin compatibility (props to megamenu for the heads up)
246
247 = 4.4.2 =
248
249 * Fix - fixed compatibility with WordPress versions prior to 4.4
250 * Fix - proportional scaling of image within the widget editor
251 * Fix - fix validation by avoiding empty attributes and only specifying sizes with srcset (thanks Zodiak1978)
252
253 = 4.4.1 =
254
255 * Fix - fixed some broken links
256
257 = 4.4 =
258
259 * Feature - Add srcset and size attribute support (props @philwp)
260 * Tweak - Readme adjustments
261 * Tweak - Additional refinements to notice code.
262
263 = 4.3.1 =
264
265 * Tweak - Upgrade admin notice code
266
267 = 4.3 =
268
269 * Translations - fixed compatibility with translate.wordpress.org
270 * Translations - restored the pot file for easier community translations
271 * Tweak - fixed a typo
272 * Tweak - Minor code cleanup
273
274 = 4.2.2 =
275
276 * Feature - Include registered image sizes in the list of selectable items (props to aaemnnosttv for the pull request!)
277
278 = 4.2.1 =
279
280 * Feature - Removing Freemius. Interesting experiment, but ultimately, not our cup of tea. Thanks for sticking with us!
281
282 = 4.2 =
283
284 * Security - Prevent direct access to directories (thank you @ramiy)
285 * Translations - Remove po/mo files, migrate to translate.wordpress.org language packs
286 * Feature - Add support for the rel attribute
287 * Feature - Adding an opt-in integration with Freemius
288
289 = 4.1.2 =
290
291 * Tweak - Added support for an id attribute on links (Props to amyh for the work on this!)
292
293 = 4.1.1 =
294
295 * Tweak - Retiring the use of PHP 4 style constructors
296
297 = 4.1 =
298
299 * Remove accidentally deployed image size update.
300
301 = 4.0.9 =
302
303 * Fix image stretching bug in admin (Thanks @kyleunzicker)
304 * Add polish translation (thank you @difreo)
305 * Add hebrew translation (thank you Ariel Klikstein)
306 * Add german translation (thank you Daniel Schmidt)
307 * Fix "Alt" text in the widget source to use actual "Alt" text (thanks @adoliver and @Degas)
308
309 = 4.0.8 =
310
311 * Responsive support in honor of Josh Broton's WordCamp SF talk about responsive design. max-width now defaults to 100%;
312
313 = 4.0.7 =
314
315 * Add Spanish translation (thank you @mzaweb)
316
317 = 4.0.6 =
318
319 * Rename all language files and implement a couple more minor language bug fixes a la @understandard
320 * Added support for the constant 'I_HAVE_SUPPORTED_THE_IMAGE_WIDGET' to turn off the message that appears after upgrading. (@crienoloog, i hope this puts a smile on your face.)
321
322 = 4.0.5 =
323
324 * Added Japanese (and fixed a minor language string bug - thank you @understandard)
325 * Added Arabic (thank you @modmenpc)
326
327 = 4.0.4 =
328
329 Super minor fix to enable saving of a blank caption. (thanks @crdunst)
330
331 = 4.0.3 =
332
333 Fixed javascript bug caused by log message.
334
335 = 4.0.2 =
336
337 Fix oversized screenshot.
338
339 = 4.0.1 =
340
341 Language updates:
342
343 * Brazilian Portuguese (Thank you @guhemama)
344 * Spanish (Thank you @javiandgo)
345
346 = 4.0 =
347
348 * Significant upgrades to support the new WordPress media manager (Thank you @kyleunzicker, @dancameron, @dudekpj, @JakePT)
349 * Significant improvements the administrative user interface.
350 * Abstracted support for older versions of WordPress so that that we don't break old versions with this upgrade (Though there's no reason you should up grade this widget and NOT your WP install! You should always keep WordPress core up to date!)
351 * Added 'image_widget_link_attributes' filter to easily process link attributes and to default to having the link 'title' be the 'alt' or 'title' content. (Thank you @ZeroGravity, @pixelyzed, and @javiandgo)
352 * Updated Translations
353 ** Swedish (Tomas Lindhoff <tomas@xhost.se>)
354 ** Dutch (Presis <contact@presis.nl>)
355 ** Italian (@maxgx)
356
357 = 3.3.8 =
358
359 * Added italian translations courtesy of @maxgx
360
361 = 3.3.7 =
362
363 * Add filters so that people can more easily adjust the output of the widget as per @TCBarrett's request.
364
365 = 3.3.6 =
366
367 * Czech translation courtesy of Vladislav Musilek at blogísek (http://blog.musilda.cz).
368
369 = 3.3.5 =
370
371 * Fix filtered media library inserts thanks to @miraclemaker as well as @oxyc, @BjornW and innumerable others in the support forum (http://wordpress.org/support/topic/plugin-image-widget-add-image-upload-an-image-select-insert-into-widget-no-image-is-shown)
372 * Adjusted HTTPS/SSL handling so that it's only applied in the view. ( thanks @TheFluffyDoneky and @aerobrent )
373 * Added a filter for the image url: 'image_widget_image_url'
374 * Add Dutch language translation ( thank you Carsten Alsemgeest - presis.nl )
375 * Rename all language files to lowercase image_widget to match the localization string.
376
377 = 3.3.4 =
378
379 * Fix javascript bugs in the widget admin UI. ( thanks for filing this @joo-joo )
380 * Fix notices in php error log.
381 * Add widget description filter $args and $instance ( thanks @jeffreyzinn )
382 * Fixed localization and renamed key to 'image-widget'
383
384 = 3.3.3 =
385
386 * Romanian translation courtesy of Alexander Ovsov at Web Geek Science (http://webhostinggeeks.com).
387
388 = 3.3.2 =
389
390 * Remove extra esc_attr() from the $title display. (Thank you @romaspit)
391
392 = 3.3.1 =
393
394 * Add minor security updates.
395 * Update readme, thumbnails and other minor descriptors.
396
397 = 3.3 =
398
399 * Fix to allow the widget to work in the non-async (browser) uploader. Props Bjorn Wijers
400
401 = 3.2.11 =
402
403 * Yet another minor JS fix to hopefully address issues of lightbox not working
404
405 = 3.2.10 =
406
407 * Fix JS typo.
408
409 = 3.2.9 =
410
411 * Minor JS fix to hopefully address issues of lightbox not working
412 * Use new the new [jQuery.fn.on](http://api.jquery.com/on/) method for forward compatibility.
413
414 = 3.2.8 =
415
416 * Minor bugfix courtesy of Takayuki Miyauchi (@miya0001)
417 * Polish translation courtesy of Łukasz Kliś
418
419 = 3.2.7 =
420
421 * Update javascript to work with the new version of WordPress (thanks Matt Wiebe!!! @mattwiebe)
422 * Added Japanese translation courtesy of Takayuki Miyauchi (@miya0001)
423
424 = 3.2.6 =
425
426 * Add HTTPS support courtesy of David Paul Ellenwood (DPE@SGS)
427
428 = 3.2.5 =
429
430 * Added Swedish translation courtesy of Tomas Lindhoff (@Tomas)
431
432 = 3.2.4 =
433
434 * Added javascript conflict prevention code thanks to @rcain.
435
436 = 3.2.3 =
437
438 * Added French translation courtesy of Dominique Corbex (@Domcox)
439
440 = 3.2.2 =
441
442 * Added Portuguese translation courtesy of Gustavo Machado
443
444 = 3.2.1 =
445
446 * Fix image widget public declaration bug.
447
448 = 3.2 =
449
450 * Abstract views for widget output and widget admin.
451 * Support theme override of the widget output! Now you can layout the widget however you'd like.
452 * Added filter to override template call.
453
454 = 3.1.6 =
455
456 * Fixed Wordpress 3.0 bugs. (Thanks @kenvunz)
457
458 = 3.1.5 =
459
460 Fixed PHP 5 bug. Removed 'public' declaration. http://wordpress.org/support/topic/362167 Thanks @mpwalsh8, @jleuze, @PoLaR5, @NancyA and @phoney36
461
462 = 3.1.4 =
463
464 * Added support for ALT tags. If no alt tag is entered the title is used.
465
466 = 3.1.3 =
467
468 * Added German language support (Thank you Rüdiger Weiß!!!)
469
470 = 3.1.2 =
471
472 * Fix bug: XHTML Compliance (thanks HGU for offering a patch and thanks @webmasterlistingarts for filing the bug)
473 * Replaced `<p>` with `<div>` in description to also improve XHTML compliance.
474
475 = 3.1.1 =
476
477 * Fix bug: php4 reported error: PHP Parse error: syntax error, unexpected T_STRING, expecting T_OLD_FUNCTION or T_FUNCTION or T_VAR or '}' (thanks @natashaelaine and @massimopaolini)
478
479 = 3.0.10 =
480
481 * Fix bug: improve tab filters.
482
483 = 3.0.9 =
484
485 * Fix bug: update tabs filter to not kill tabs if upload window is for non widget uses.
486
487 = 3.0.8 =
488
489 * Remove the "From URL" tab since it isn't supported.
490 * Replace "Insert into Post" with "Insert into Widget" in thickbox.
491
492 = 3.0.7 =
493
494 * Fix Dean's Fcuk editor conflict. (Thanks for the report Laurie @L_T_G)
495 * Fix IE8 bug (Remove extra comma from line 66 of js - thanks for the report @reface)
496 * Update functions and enqueued scripts to only trigger on widget page.
497
498 = 3.0.6 =
499
500 * Fix crash on insert into post.
501
502 = 3.0.5 =
503
504 Thank you @smurkas, @squigie and @laurie!!! Special thanks to Cameron Clark from http://prolifique.com a.k.a @capnhairdo for contributing invaluable javascript debugging skills and throwing together some great code.
505
506 * PHP4 compatibility
507 * Tighter integration with the thickbok uploader attributes including caption, description, alignment, and link
508 * Tighter image resize preview
509 * Add Image link becomes "Change Image" once image has been added
510
511 = 3.0.4 =
512
513 * Minor description changes
514
515 = 3.0.3 =
516
517 * Fixed the broken "Add Image" link (THANK YOU @SMURKAS!!!)
518
519 = 3.0.2 =
520
521 * Added PHPDoc comments
522 * Temporarily fixed install bug where no image is saved if resize is not working. (thank you Paul Kaiser from Champaign, Il for your helpful QA support)
523
524 = 3.0.1 =
525
526 * Added 'sp_image_widget' domain for language support.
527
528 = 3.0 =
529
530 * Completely remodeled the plugin to use the native WordPress uploader and be compatible with Wordpress 2.8 plugin architecture.
531 * Removed externalized widget admin.
532
533 = 2.2.2 =
534
535 * Update <li> to be $before_widget and $after_widget (Thanks again to Lois Turley)
536
537 = 2.2.1 =
538
539 * Update `<div>` to be `<li>` (Thanks to Lois Turley)
540
541 = 2.2 =
542
543 * Fixed missing DIV close tag (Thank you Jesper Goos)
544 * Updated all short tags to proper php tags (Thank you Jonathan Volks from Mannix Marketing)
545
546 = 2.1 =
547
548 * Link Target
549
550 = 2.0 =
551
552 * Multi widget support
553 * WP 2.7.1 Compatibility
554 * Class encapsulation
555
556 == Upgrade Notice ==
557
558 = 4.0 =
559
560 Please be advised that this is a significant upgrade. You should definitely back up your database before updating in case your existing image widgets have any problems.
561
562 Also, several languages will no longer be supported until new translations are submitted. Currently, we have support for Italian, Dutch, and Swedish. If you would like to contribute your own language files, please post links here:
563
564 http://wordpress.org/support/topic/image-widget-40-translations-needed-2
565