forked from vollyimnetz/crop-thumbnails
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
351 lines (279 loc) · 17.7 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
=== Crop-Thumbnails ===
Contributors: volkmar-kantor
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=volkmar%2ekantor%40gmx%2ede&lc=DE&item_name=Volkmar%20Kantor%20%2d%20totalmedial%2ede&item_number=crop%2dthumbnails&no_note=0¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHostedGuest
Tags: post-thumbnails, images, media library
Requires at least: 4.6
Tested up to: 5.8.0
Requires PHP: 5.6.0
Stable tag: 1.4.0
License: GPL v3
License URI: http://www.gnu.org/licenses/gpl-3.0.html
"Crop Thumbnails" made it easy to get exacly that specific image-detail you want to show in your featured image or gallery image.
== Description ==
The plugin provides the functionality to adjust the crop region of cropped images. It add buttons to the edit-pages and media-dialog to access a crop-editor.
In the crop-editor you can choose one or more (if they have the same ratio) imagesizes and cut-off the part of the image you want.
The plugin is especially useful for theme developers who want to keep full control over cropped image sizes. If you want to dive even deeper, you can get informations about the hooks and filters on the [github page of the plugin](https://github.com/vollyimnetz/crop-thumbnails).
== Installation ==
You can use the built in installer and upgrader, or you can install the plugin manually.
1. You can either use the automatic plugin installer or your FTP program to upload it to your wp-content/plugins directory the top-level folder. Don't just upload all the php files and put them in /wp-content/plugins/.
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Configure any settings from "Settings > Crop-Thumbnails".
4. Use it.
== Frequently Asked Questions ==
= How to define cropped image sizes? =
The plugin do not add additional image sizes, it only provides functionality to edit the crop area.
You can use "`add_image_size`" inside your functions.php to add additional cropped image sizes. [See "add_image_size" documentation](https://developer.wordpress.org/reference/functions/add_image_size/).
`
add_action( 'after_setup_theme', 'my_adjust_image_sizes' );
function my_adjust_image_sizes() {
//add an cropped image-size with 800 x 250 Pixels
add_image_size( 'my-custom-image-size', 800, 250, true );
/**
* The following image sizes use a dynamic value.
* USE WITH CARE
* Also the plugin supports these image-sizes, i do not recommend them!
**/
//a dynamic cropped image size with 500 pixel height and the width of the original image
add_image_size( 'my-dynamic-width-1', 9999, 500, true );
//a dynamic cropped image with the same ratio as the original image and 500 pixel width
add_image_size( 'my-dynamic-zero-height-1', 500, 0, true );
}
`
After you add the image-size any futher image uploads will produce a cropped image "my-custom-image-size" which you can use in post-loop:
`
if ( has_post_thumbnail() ) {
the_post_thumbnail( 'my-custom-image-size' );
}
`
= What internal rules the plugin use for cropping? =
* The plugin will only crop image-sizes where crop is set to "`true`" (hard crop mode - see: http://codex.wordpress.org/Function_Reference/add_image_size).
* If you had set one image dimension in add_image_size() to "`0`", the plugin will crop it in the ratio of the original image.
* If you had set one image dimension in add_image_size() to "`9999`", the plugin will change the 9999 to the actual size of the current original image.
* You are able to crop all images with the same ratio at once (default) or and any imagesize (and ratio) seperate.
= How to use this plugin on ACF taxonomy-images
The "Adavanced Custom Fields" plugin has a functionality to add images to taxonomies. To add cropping functionality on these images you have to add a small code-snippet to your functions.php
[Have a look on the github readme-page for details.](https://github.com/vollyimnetz/crop-thumbnails#filter-crop_thumbnails_activat_on_adminpages)
= I've cropped the image, but the new version do not appear in the frontend. =
If you had viewed your image on the site before, your browser has cached the image. You can hard refresh the page by hitting:
* "`CTRL + F5`" (on Windows)
* "`Apple + R`" or "`command + R`" (on Mac/Apple)
= Is it possible to crop an non-cropped image-size? =
No. The purpose of this plugin is to provide control for the wordpress automatic crop. If you want to crop let's say the full-size image you should
* a) upload it in a better format in the first place
* OR b) use the Standard Wordpress-Image editor to crop the image.
= Where can I get developer information? =
A documentation with a list of all actions and filters can be found on the [Github page of the project](https://github.com/vollyimnetz/crop-thumbnails).
= I have two image-sizes that have nearly the same ratio. I want to make use of the feature "Crop all images with same ratio at once", but cause the ratios are slightly different they wont be selected together. =
You can add the following filter in the functions.php of your theme to adjust the ratio of one or more specified image-sizes.
CAUTION: use only when the ratios are really close.
`
add_filter( 'crop_thumbnails_editor_printratio', 'my_crop_thumbnails_editor_printratio', 10, 2);
function my_crop_thumbnails_editor_printratio( $printRatio, $imageSizeName) {
if($imageSizeName === 'strange-image-ratio') {
$printRatio = '4:3';//do override ratio
}
return $printRatio;
}
`
= I display the cropped image in the backend in an custom meta-box. It does not update after the modal-dialog closed. Is there a way to fix this =
Yeah, there is a way. After the crop-thumbnails-modal closed it triggeres a javascript event on the body element. You could use jQuery to cache-break your cropped thumbnail (in backend-view).
The event called "cropThumbnailModalClosed". The plugin also provides a global function that could be called (only in post-edit-view and mediathek) to do the cache-break.
Example-Code:
`
$('body').on('cropThumbnailModalClosed',function() {
CROP_THUMBNAILS_DO_CACHE_BREAK( $('.your-image-selector') );
});
`
= What languages are supported? =
You may have a look on the [Translation Page](https://translate.wordpress.org/projects/wp-plugins/crop-thumbnails).
= I want to contribute code. =
Fantastic, i published the code on [github](https://github.com/vollyimnetz/crop-thumbnails). But be warned, i am carefully evaluate new features.
If you fork and planning to publish the forked plugin, please contact me.
== Screenshots ==
1. You have access to the crop-editor on the media-panel by clicking "Crop Featured Image".
2. Choose one or more images (with the same ratio).
3. The crop-editor is also integrated in the list-view of the media library.
4. Choose what image-sizes should be hidden (for what post-types), for better usability.
5. Quicktest on settings-page, to check if your system is correct setup.
== Changelog ==
= 1.4.0 =
* its possible to crop webp files with the plugin
* library updates
* code cleanup
* add fix for using replacement MIME-type specified for sub-sizes (thanks to https://github.com/benjibee - https://github.com/vollyimnetz/crop-thumbnails/issues/55)
= 1.3.1 =
* crop-editor: if grouped, the notification for not yet cropped image-sizes now is visible if at least one of the images in the group is not yet cropped
* fix bug on settings page (noticible only on strict configured php environments)
* fix bug in file saving (noticible only on strict configured php environments)
= 1.3.0 =
* remove support for Code below PHP 5.4: ( the construct dirname(__FILE) become __DIR__, arrays will also be initialized using [] )
* remove legacy language translation (in pot/po/mo files) - if you want to have the plugin in your language you can use https://translate.wordpress.org/projects/wp-plugins/crop-thumbnails/
* change app deployment to vue-cli
* add functionality for grouping of image-sizes in crop editor
* add the actions "crop_thumbnails_before_crop" and "crop_thumbnails_after_crop" to hook directly before and after the cropping
* add the filter "crop_thumbnails_do_crop" to make an exchange of the cropping function possible
* fix broken link (thanks to TangRufus - https://github.com/TangRufus)
* add code contribution of TangRufus to make plugin compatibility with "Crop Thumbnails CDN Cache Busting" (thanks to TangRufus - https://github.com/TangRufus)
* add the filter "crop_thumbnails_should_delete_old_file" to make an exchange of the check for file-deleting possible
= 1.2.6 =
* update dependencies
* fix typo
* fix a bug where the image name of the thumbnail changed to "imagename-scaled-..." cause of the new features of WordPress 5.3
* extend the filter "crop_thumbnails_filename" by the image-metadata-array
= 1.2.5 =
* fix a bug that may occur on utf8-filenames
* update vue.js and the other libraries to current version
* refactoring vue-code and build
= 1.2.4 =
* change the enqueue-name of the vue.js-library provided with the plugin to "cpt_vue" to make it possible to prevent this specific include
* update js-dev dependencies
* add the filter "crop_thumbnails_filename" to make it possible to change the target path/filename (thanks to https://github.com/matzeeable)
* improve readme
= 1.2.3 =
* fix a php-notice displayed on the settings-screen
= 1.2.2 =
* fix calling a non static function in a static statically (fixes a bug where the plugin do not run locally)
= 1.2.1 =
* fix a javascript-bug that occurs in Wordpress 4.9.2 in relation with yoast seo-plugin
= 1.2.0 =
* the used cropping data are now stored in the image after the crop, making it possible to code a plugin for restoring the cropped region on new image-sizes
* fix for hiding crop sizes is not working when the image_size_names_choose-filter is used for that post-type
* change permission from 'upload_files' to 'edit_files' (Attention: authors will no longer able to crop the thumbnails)
* add a filter function to override the permission to crop thumbnails (crop_thumbnails_user_permission_check)
* add settings-section to set if users can crop thumbnails with capability "edit_files" or "upload_files"
* get featured image panel button working in wordpress v5
= 1.1.3 =
* add a filter (crop_thumbnails_activat_on_adminpages), for adding the plugins js/css on futher admin-pages like the taxonomy edit-page.
* update js and webpack dependencies
= 1.1.2 =
* add an css-class on the listing of image-sizes
= 1.1.1 =
* bugfix change use of mime_content_type() to wp_check_filetype() - it seems on some servers mime_content_type() is undefined
= 1.1.0 =
* bugfix variable was used but not defined (php)
* bugfix image-size with custom name where not updated in view after crop
* bugfix all same image-sizes where selected, even if they are not visible
* in the settings-panel, add more quick-test informations
* redesign settings-panel
* make selected image-sizes more clear
* optimize development-build-process
* add warning sign for not yet cropped images-sizes
= 1.0.3 =
* fix js error handling
* add warning to the backend if the script cant connect the server
* fix where escape of language-strings make no sense (exceptions in save.php)
= 1.0.2 =
* improve i18n
* change language text domain from 'cpt_lang' to 'crop-thumbnails'
* rename language files to match text domain exactly
* change 'CROP_THUMBS_VERSION' to 'CROP_THUMBNAILS_VERSION'
* correct translations of the plugins name
= 1.0.1 =
* fix code that mess with old php versions
= 1.0.0 =
* modal dialog rewritten
* crop functionality refactored
* changed the crop-library for improved touch support
* the action "crop_thumbnails_modal_window_settings" is gone, you can adjust style by override admin-css
* the filter "crop_post_thumbnail_window_css" is gone, you can adjust style by override admin-css
* adjusting dialog style - make it more responsive
* reviewed dynamic sizes: sizes with 9999 will no longer have ratio of the original image
* reviewed dynamic sizes: filenames will no longer be changed
* fix image-metadata polution
* refactoring and cleanup a lot of the code
* change from a language constant to 'cpt_lang'
* secure translations
= 0.10.15 =
* bugfix: use wordpress-function to determine mime-type, as some servers do not define "mime_content_type" (Thank you Eskil Keskikangas for the submission)
= 0.10.14 =
* bugfix: add mime-type to image-metadata (the mime-type was deleted by crop-thumbnails before unintentional)
= 0.10.13 =
* bugfix: filter-settings will work again in media-dialog
= 0.10.12 =
* add italian translation (thanks to akteon18)
= 0.10.11 =
* bugfix: hide disabled image-sizes in the crop-editor again
= 0.10.10 =
* bugfix: Checks if the current page have a featured image box in the first place
= 0.10.9 =
* bugfix: click on the button in the featured image box (WP 4.6 and above)
* button in featured image box is no longer visible if no image is choosed
* minor style improvements
= 0.10.8 =
* change empty-array-definition to be compatible with old PHP-Versions (prior 5.4)
= 0.10.7 =
* fix a behaviour where the 'image_size_names_choose'-filter could remove image-sizes from the settings page
* add a seperate filter 'crop_thumbnails_image_sizes' to remove/adjust image-sizes used by the plugin (use carefully)
* use DIRECTORY_SEPARATOR in the save-function
* add a quicktest to the settings screen
= 0.10.6 =
* improve the bugfix of 0.10.5 (sorry for that)
= 0.10.5 =
* bugfix: proper handling of non latin characters in filenames
= 0.10.4 =
* i18n of the button in the image-media-view changed
* add 'medium_large' size to (intern) default-sizes (fix notice)
* add action-hook 'crop_thumbnails_after_save_new_thumb' after save the new thumbnail
* add filter-hook 'crop_thumbnails_before_update_metadata' before update metadata
* add filter-hook 'crop_thumbnails_editor_jsonDataValues' in the editor, to adjust dataValues
* add filter-hook 'crop_thumbnails_editor_printratio' in the editor (see F.A.Q. for details of usage)
= 0.10.3 =
* small language adjustments
= 0.10.2 =
* make the modal-dialog more robust against css-overriding of other plugins
= 0.10.1 =
* small enhancement for developers: add the 'same_ratio_active' parameter in the ajax-request (https://wordpress.org/support/topic/return-same-ratio-daja-in-ajax-request)
= 0.10.0 =
* refactoring some parts of the code to make it more modular
* adding a cache breaker to the backend, so in post-view and mediathek the image should be refreshed after the modal-dialog closes
* provide a javascript-event ('cropThumbnailModalClosed') after the modal is closed (see F.A.Q. for details)
* provide the human-readable Name of the Crop-Size (if available), using the "image_size_names_choose" filter
* provide some size settings for the modal-dialog - via filter "crop_thumbnails_modal_window_settings"
* mini language update
= 0.9.0 =
* add crop-thumbnail-button to the default attachement-screens so i could accessed better
* change modal-dialog from thickbox to ui-dialog
* fix the missing crop-thumbnail-button in the attachment-list-view
= 0.8.4 =
* fix a bug that may occur on some systems with xdebug enabled and low xdebug.max_nesting_level (see: http://wordpress.org/support/topic/error-when-trying-to-crop-a-certain-image)
* add dutch language (thanks to Max Gruson)
= 0.8.3 =
* fix a bug for systems with comma as dezimal seperator (http://wordpress.org/support/topic/doesnt-save-the-cropped-image-anywhere?replies=12#post-4563377)
* reduce capabilities from "edit_pages" AND "upload_files" to only "upload_files"
* more informations logged in the console if an error occurs while saving
= 0.8.2 =
* add filter for customize the style of the crop-thumbnail content ('crop_post_thumbnail_window_css')
* add a fix for dynamic height/width images (http://wordpress.org/support/topic/dynamic-widthheight)
* add ukrainian language (thanks to Jurko Chervony from www.skinik.name)
= 0.8.1 =
* fix warning: when settings are saved
= 0.8.0 =
* change Constant from CPT_VERSION to CROP_THUMBS_VERSION
* bug fix: wrong calculated scale in the cpt-crop.js (selection will again always fill the maximum space)
* change behavior: on landscape-ratio-images the selection will be initial in the middle of the image (portrait-ratio-images stay the same - i asume that portrait-ratio images are mostly portraits)
* add current jcrop (version v0.9.12) directly into the plugin to get rid of the subversion of cpt-crop.js for an prior version of jcrop in wordpress 3.4
* add settings-option to display debug (js and/or data)
* handle image-sizes with zero width or height
* fix notices: not set variables
* fix warnings: if an image-size is zero
= 0.7.2 =
* bug fix: change the way the link in the featured Image-Box is set
* languages: some adjustments
= 0.7.1 =
* add language: brazilian portuguese (pt_br)
* bug fix: fixes for the upcoming Wordpress 3.5
* bug fix: in crop editor, if an original image is larger than a single selected image-size, the predefined selection will now be on maximum possible size
* bug fix: ensure that other plugins can´t add styles and scripts into the crop-thumbnail-iframe
= 0.7.0 =
* workflow-enhancement: change the way the plugin handled same image-ratios (faster editing and less warnings)
* the image-size with the biggest dimensions now is used for the min-boundaries (jcrop)
* if the min-boundaries (jcrop) are bigger than original image the min-boundaries turned off
= 0.6.0 =
* add a settings link in the plugin-listing
* add a support-author area in the settings
* update language files
* Fix the readme-file for correct display informations on wordpress.org
* add screenshots for wordpress.org
* add license.txt
= 0.5.0 =
* Initial Version