forked from cloudinary/cloudinary_wordpress
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
416 lines (287 loc) · 19.3 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
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
=== Cloudinary – Image and Video Optimization, Manipulation, and Delivery ===
Contributors: Cloudinary, XWP, Automattic
Tags: images, videos, DAM, optimization, CDN
Requires at least: 4.7
Tested up to: 5.8.3
Requires PHP: 5.6
Stable tag: STABLETAG
License: GPLv2
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Use Cloudinary's plugin to efficiently create, manage and deliver images, videos, and other media, personalized and optimized for every device and channel.
== Description ==
Cloudinary’s [award-winning plugin](https://www.businesswire.com/news/home/20200923005566/en/Cloudinary-Wins-2020-MarTech-Breakthrough-Award-for-Best-WordPress-Plugin) makes automating your image, video, and visual media workflows easy, offering a variety of features. From image and video upload through management, transformation, optimization, and global CDN delivery, all features are offered within the plugin. Users can get started in minutes with a true plug-and-play solution paired with an intuitive onboarding wizard helping deliver optimized and responsive media out-of-the-box.
https://youtu.be/B1Jx5hB1Ijk
On top of that, users can also leverage a dashboard giving insights into optimization metrics and data usage so there are never any surprises. No matter if your use case is for personal use or business needs, the Cloudinary plugin offers enterprise quality and architecture for all.
Optimize your site performance and user experience with faster page load times and advanced auto-responsive delivery, allowing you to improve your Google page rankings, Core Web Vitals, and Lighthouse scores. Publish faster while consistently delivering positive user experiences via an array of automated features such as video and image optimization, advanced responsive design, customizable lazy loading, and fast CDN delivery of assets. Display engaging visual experiences with automated quality and encoding settings, video and image resizing and cropping via AI, comprehensive transformations and effects, and delivery to any device in any resolution or pixel density.
And with a full Digital Asset Management platform embedded in the plugin, you won’t need to leave your WordPress environment. Take full advantage of advanced search, AI-based tagging, rich media editing, collections, structured metadata, and an intuitive UI as well as our Video and Image APIs for headless DAM functionality, making it much easier to manage all of your media in WordPress.
== Highlights ==
* End-to-end support for the popular WooCommerce plugin along with the ability to replace the WooCommerce gallery with a responsive and customizable product gallery.
* Compatibility with popular page builders helping with tasks such as building forms, fine-tuning SEO, establishing communities, managing multi language setups, and more.
* Automatically optimize videos and images and apply specified global transformations to pre-existing media upon plugin installation as well as all future uploads.
* Automatic responsive images for delivery on various devices in different resolutions with exact pixel accuracy.
* Automatically lazy load images and videos with customizable placeholder settings.
* Automatic image and video optimization of assets located outside of the media library in themes, plugins, and more.
* Ability to display videos using Cloudinary’s video player giving additional features such as bitrate limit, autoplay, analytics, monetization, and more.
* The most comprehensive array of image and video transformation capabilities, powered by AI.
* Set transformations by “category” or “tag” in real time with taxonomy level transformations.
* Transcode, AI crop, apply filters, generate thumbnails, and more with our video transformation capabilities.
* Search and browse your media with AI-powered tagging and attributes including file type, size, format, and many other parameters all within the media library.
* Utilize developer friendly documentation allowing users to further extend the plugin with advanced capabilities and features.
== Getting Started ==
To use the Cloudinary Plugin and all the functionality that comes with it, you will need to have a Cloudinary Account. **If you don’t have an account yet, [sign up](https://cloudinary.com/signup?source=wp&utm_source=wp&utm_medium=wporgmarketplace&utm_campaign=wporgmarketplace) now for a free Cloudinary Programmable Media account**. You’ll start with generous usage limits and when your requirements grow, you can easily upgrade to a plan that best fits your needs. Upon account creation you can plug in your account credentials and customize your configurations as desired. That’s it.
**Upgrade Messaging**
Enjoy a seamless upgrade to experience the completely new look and feel of our plugin. Boasting many new features including our digital asset management platform, video player offering advanced capabilities, auto-responsive images, customizable lazy loading, responsive and interactive product gallery, automatic optimizations and transformations, and much more.
== Frequently Asked Questions ==
**I’ve installed the plugin, what happens now?**
If you left all the settings as default, all your current media will begin syncing to Cloudinary and will start to be optimized and delivered by fast CDN on your website using Cloudinary URLs. Once the syncing is complete, you should start seeing improvements in performance across your site.
**Which file types are supported?**
Most common media files are supported for optimization and delivery by Cloudinary. For free accounts, you will not be able to deliver PDF or ZIP files by default for security reasons. If this is a requirement, please [contact our support team](https://support.cloudinary.com/hc/en-us/requests/new) who can help activate this for you.
To deliver additional file types via Cloudinary, you can extend the functionality of the plugin using the [actions and filters](https://cloudinary.com/documentation/wordpress_integration#actions_and_filters) the plugin exposes for developers.
**I have various other plugins installed, will the Cloudinary Plugin still work?**
**I’m having an incompatibility issue with a theme, plugin, or hosting environment, what can I do?**
We’re compatible with most other plugins so we expect it to work absolutely fine. If you do have any issues, please [contact our support team](https://support.cloudinary.com/hc/en-us/requests/new) who will help resolve your issue.
**Why are my images loading locally and not from Cloudinary?**
Your images may be loading locally for a number of reasons:
* The asset has been selected to be delivered from WordPress. You can update this for each asset via the WordPress Media Library.
* Your asset is stored outside of your WordPress storage.
* The asset is not properly synced with Cloudinary. You can find the sync status of your assets in the WordPress Media Library.
== About Cloudinary ==
Read more about Cloudinary:
* [Our website](http://cloudinary.com/)
* [Blog](http://cloudinary.com/blog)
* [Feature guides](https://cloudinary.com/documentation/cloudinary_guides)
* [DAM solution](https://cloudinary.com/products/digital_asset_management)
* [Detailed documentation](http://cloudinary.com/documentation)
* [Image transformations documentation](http://cloudinary.com/documentation/image_transformations)
* [Video transformations documentation](https://cloudinary.com/documentation/video_manipulation_and_delivery)
* [Cloudinary FAQ](http://cloudinary.com/faq)
== Customer Case Studies ==
* [Complex Networks](https://cloudinary-res.cloudinary.com/image/upload/v1606310155/website/resources/case-study/cloudinary_case_study_complex_networks_0720_v2.pdf)
* [StubHub](https://cloudinary-res.cloudinary.com/image/upload/v1599569503/website/resources/case-study/cloudinary_case_study_stubHub_0820_fnl.pdf)
* [Fairfax Media](https://cloudinary-res.cloudinary.com/image/upload/v1599569441/website/resources/case-study/cloudinary_case_study_Fairfax_Media_0720_fnl.pdf)
== Contributors & Developers ==
“Cloudinary – Dynamic Image and Video Management” is an open source software. The following people have contributed to this plugin:
[Cloudinary](https://profiles.wordpress.org/cloudinary/)
[XWP](https://profiles.wordpress.org/xwp/)
[Automattic](https://profiles.wordpress.org/automattic/)
== Installation ==
= Install from within WordPress =
* Visit the plugins page within your dashboard and select `Add New`.
* Search for `Cloudinary`.
* Select "Cloudinary – Image and Video Optimization, Manipulation, and Delivery" from the list.
* Activate `Cloudinary` from your Plugins page.
* Go to `Setting up` below.
= Install Cloudinary manually =
* Upload the `Cloudinary` folder to the /wp-content/plugins/ directory.
* Activate the `Cloudinary` plugin through the `Plugins` menu in WordPress.
* Go to `Setting up` below.
= Setting up =
* Once the plugin is activated, go to the `Cloudinary` settings.
* You’ll be prompted to “Add your Cloudinary URL”.
* Enter your “Cloudinary environment variable URL”, the format should be cloudinary://{API_Key}:{API_Secret}@{Cloud_Name} and can be found in the "Account Details" section of the Cloudinary Console Dashboard, then click save.
* After saving, additional settings tabs will be available.
**Note**
If you have two factor authentication configured for your account, you will need to open the Cloudinary Console and login before you can use the Cloudinary plugin.
Your site is now setup to start using Cloudinary.
== Screenshots ==
1. Streamline Your Creative Workflow
1. Media Editor
1. DAM-Powered Media Library
1. Easy Generation of Asset Derivatives
1. Automatically Deliver Responsive Images
1. Global Image Transformation Settings
1. Global Video Transformation Settings
1. Improve web performance with Lazy Loading assets
1. Display assets in a customizable and responsive product gallery
1. Folder and Syncing Settings
1. Additional Syncing Settings
1. Gain insight into how your assets are performing
1. Easily Configure Your Account
1. Configure your assets to be automatically optimized out-of-the-box
1. Need help? We’ve got you covered
== Changelog ==
3.0.1 (18 January 2021)
Fixes and Improvements:
* Added SVG support (beta)
* Improved custom HTML for Featured images
* Fixed extra request handling on faulty 'srcset'
* Improved how the plugin handles image cropping functionality
* Fixed the URL where in some cases the delivery URL was wrong
* Fixed db errors related to wp_cloudinary_relationships table
* Fixed "Uncaught TypeError: Cannot read properties of undefined (reading 'length')" error
* Fixed System report missing data
= 3.0.0 (06 December 2021) =
Release of a new major version of the plugin
* Entire new look and feel
* New set-up wizard for a quick and simple configuration
* New Dashboard displaying the optimization level of your site’s assets
* New improved section of the dashboard displaying your Cloudinary’s plan details
* New levels of optimization settings across the plugin screens
* New asset sync settings which allows to sync additional media files such as themes & plugins
* New External Asset Sync settings from specific external sources with Cloudinary
* Cloudinary DAM as a new extension of the plugin
* New lazy loading controls with built in simulation!
* Added a preview to the Responsive images settings which now includes new DPR control
* Granular control of asset transformations within the WordPress media library
* New Cloudinary status as an extra information overlay on the frontend - images only
* Brand new Help Centre screen
= 2.7.7 (11 October 2021) =
Fixes and Improvements:
* General improvement of the Cloudinary only storage
* Improved the compatibility with future Gutenberg versions
* Introduced filter support for external domains assets upload
* Moved Cloudinary logs to it's own meta key
* Fixed the explicit delivery image file format
* Fixed the grid view thumbnail sizes on WordPress media library
= 2.7.6 (16 August 2021) =
Fixes and Improvements:
* Added context to Cloudinary scripts to prevent conflict with other plugins
* Fixed raw files delivery duplicating the file extension
* Fixed typo when upgrading from v1 to v2 of the plugin
* Fixed Cloudinary Only storage where image pulled from Cloudinary are saved locally
= 2.7.5 (20 July 2021) =
Fixes and Improvements:
* Decoupling Cloudinary metadata from attachment metadata
* Fixed the duplicated suffix when re-syncing assets to Cloudinary
* Added a query parameter to the requested URL's
= 2.7.4 (23 June 2021) =
Fixes and Improvements:
* Improved the re-sync asset mechanism speed
* Fixed compatibility issue with WP Webhooks plugin
* Fixed invalid transformation message on the preview screen
* Fixed the ordering of scaled transformations
* Fixed legacy core compatibility issue on WP version prior to 5.3
* Fixed the override the transformation of featured image
* Fixed the system report which now includes Cloudinary’s configurations
= 2.7.3 (26 May 2021) =
Fixes and Improvements:
* Added support for setting the connection string as a constant
* Fixed the asset suffix being duplicated in the metadata while asset is syncing
* Fixed the default meta key on get_post_meta
* Fixed the display of the “Uninitialized string offset: 0” notice
= 2.7.2 (11 May 2021) =
Fixes and Improvements:
* Fixed overriding files with the same name
= 2.7.1 (20 Apr 2021) =
Fixes and Improvements:
* Fixed support for syncing assets' caption metadata
* Added system report to the deactivation form
* Product gallery scripts are now loaded only when needed
* Fixed manual sync of a single asset
* Fixed issues related to "Cloudinary only storage" option
* Fixed delivery of fetched/other special image types from Cloudinary
* Fixed an error when using the "Twenty Twenty" theme
= 2.7.0 (15 Mar 2021) =
New Features:
* All WordPress Media Library file types are now syncable to Cloudinary
* Added system report for better support experience
* Added bottom option into the product gallery main carousel parameter
* Added Pad modes into the product gallery main viewer parameter
* Added Fill modes into the product gallery main viewer parameter
* Video player loading performance was improved
Fixes and Improvements:
* Updated Cloudinary video player to version 1.5.1
* Fixed product gallery in case of adding unsynced asset
* Fixed WordPress Media Library error when editing an asset already synced to Cloudinary
* Fixed sync failure for media added as an external URL by other plugins
= 2.6.0 (01 Feb 2021) =
New Features:
* Added a "wp cloudinary analyze" CLI command which returns the synchronization state of the assets
* Added a "wp cloudinary sync" CLI command which triggers the synchronization of all pending assets
Fixes and improvements:
* Sync process improvements
* Sync process 1000 asset limitation was removed
* Folder path now supports forward slashes
* Deleting media on the WordPress media library will now delete them on Cloudinary
* Fixed an infinite loading issue when using videos
* Fixed compatibility issues with Smush plugin
* Fixed compatibility issues with using the Cloudinary tab in ACF plugin
* Minor cosmetic updates
= 2.5.0 (20 Jan 2021) =
New Features:
* Brand new user interface!
* Introducing the Cloudinary Product Gallery (beta feature):
- We added a new 'Cloudinary Gallery' block to the Gutenberg Editor
- When using WooCommerce, you can now use the 'Cloudinary Gallery' as your default product gallery
* Added a rate-us link. Please rate us! ;-)
* Added support for conditional transformations
Fixes and improvements:
* Improve the REST API capabilities for better integrability
* Bug fixes
= 2.4.1 (07 Jan 2021) =
Fixes and improvements:
* Improved server calling efficiency
* More fixes
= 2.4.0 (10 Nov 2020) =
New Features:
* Added breakpoints support for featured images
* Global transformations on both Categories and Tags pages are now collapsible
* On plugin deactivation, we will ask you to share with us the reason. It’s important to us :)
Fixes and improvements:
* Fixed an issue with syncing a deleted asset
* Improved the mechanism for removing the Cloudinary account
* The warning message for exceeding the annual unit plan was revised
* Improved the Alt text synchronization from Cloudinary to WordPress
* Fixed WPBakery error when inserting an image by the WordPress editor
* Fixed AMP plugin conflict issue
= 2.3.0 (05 Oct 2020) =
New Features:
* Added a poster image for video asset
Fixes and improvements:
* Re-sync assets to user specified folder instead of root
* Store the original uploaded image to cloudinary
* Fixed 'Resource not found' error when changing credentials
* Fixed incompatibility with text media block
= 2.2.1 (30 Sep 2020) =
Fixes and Improvements:
* Fixed an error when toggling 'featured image overwrite' on a custom post type
= 2.2.0 (08 Sep 2020) =
New Features:
* You can now off-load all assets from WordPress to Cloudinary!!
* Automatically convert unsupported media file types (such as INDD, PSD, TIFF, etc) to WordPress supported file types
* Synchronization mechanism was re-built and now exposes a more granular status updates
* Lazy load polyfills for outdated browsers
* Add the ability to overwrite the global transformation to a feature image
* High quota usage alert is now dismissible
* Updated Cloudinary brand
Fixes and Improvements:
* Sync tab UI improvements
* Various performance improvements
* Fixed an issues where excessive transformations being created due to breakpoints not disabling
* Sync assets to allow for unique naming, to prevent overwriting existing items
= 2.1.9 (04 Aug 2020) =
Fixes and Improvements:
* Upgraded the Cloudinary video version
* Added two new synced icons: Downloading and Syncing meta data
* Minor UI improvements
* Bug fixes:
- Fixed the $wpsize_!_cld_full! param that can be observed in the Cloudinary URL
- Fixed wrong calculation of quota credits vs percentage
- Fixed Upload error on files over 100mb from the previous version
- Fixed the Ability of Changing the Public Id
- Fixed Interaction with code blocks with filters that might cause “invalid content”
- Fixed Overwrite transformations on videos
- Fixed excessive backslash stripping
= 2.1.2 (09 Jun 2020) =
Fixes and Improvements:
* Fixed cases where the image size were added to the URL.
* Added support to dashes ('-') in the connection string.
* Added an option to re-sync a single asset to Cloudinary.
= 2.1.1 (01 Jun 2020) =
New features:
* We now provide several options for the WP<->Cloudinary sync, allowing you to better control your media:
- Bulk-sync - Will sync all assets with Cloudinary in a click-of-a-button.
- Auto-sync - Will sync new uploaded assets in an on-demand manner.
- Manual - Added a `push to Cloudinary` button to the Media Library bulk actions that allows syncing selected assets to Cloudinary.
* Global Transformations are now being applied to Featured Images.
* Added an `Account Status` to the dashboard tab, displaying the account usage, quota and metrics.
Fixes and Improvements:
* Improved the sync mechanism.
* General bug fixes and performance improvements.
* Improved error handling.
= 2.0.3 (03 Apr 2020) =
* Fix migration issue
= 2.0.0 (31 Mar 2020) =
* Release of a new major version of the plugin
== Upgrade Notice ==
Enjoy a seamless upgrade to experience the completely new look and feel of our plugin. Boasting many new features including our digital asset management platform, video player offering advanced capabilities, auto-responsive images, automatic optimizations and transformations, and much more.