PluginProbe
Embed Privacy / 1.10.5
Embed Privacy v1.10.5
1.14.0 1.13.0 trunk 0.1 1.0.0 1.0.1 1.0.2 1.1.0 1.1.1 1.1.2 1.1.3 1.10.0 1.10.1 1.10.10 1.10.2 1.10.3 1.10.4 1.10.5 1.10.6 1.10.7 1.10.8 1.10.9 1.11.0 1.11.1 1.11.2 All 68 releases
embed-privacy / readme.txt

readme.txt in Embed Privacy 1.10.5, at readme.txt

447 lines 18.7 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 === Embed Privacy ===
2 Contributors: epiphyt, kittmedia, krafit
3 Tags: oembed, privacy, gutenberg, iframes, performance
4 Requires at least: 5.9
5 Stable tag: 1.10.5
6 Tested up to: 6.6
7 Requires PHP: 5.6
8 License: GPL2
9 License URI: https://www.gnu.org/licenses/gpl-2.0.html
10
11 Embed Privacy prevents the loading of embedded external content and allows your site visitors to opt-in.
12
13 == Description ==
14
15 Content embedded from external sites such as YouTube or Twitter is loaded immediately when visitors access your site. Embed Privacy addresses this issue and prevents the loading of these contents until the visitor decides to allow loading of external content.
16 But Embed Privacy not only protects your visitor's privacy but also makes your site load faster.
17
18 All embeds will be replaced by placeholders, ready for you to apply style as you wish. With only a couple of lines of CSS.
19
20 By clicking on the placeholder the respective content will then be loaded.
21
22 **Note: This plugins requires the PHP extension ["Document Object Model" (php-dom)](https://www.php.net/manual/en/book.dom.php).**
23
24 == Installation ==
25
26 1. Upload the plugin files to the `/wp-content/plugins/embed-privacy` directory, or install the plugin through the WordPress plugins screen directly.
27 1. Activate the plugin through the 'Plugins' screen in WordPress.
28 1. Embedded content will automatically be replaced by a placeholder and can be loaded on demand by your visitors. There are no additional settings.
29 1. To allow users to opt-out of embed providers that they set to always active, place the shortcode `[embed_privacy_opt_out]` into your privacy policy.
30
31
32 == Frequently Asked Questions ==
33
34 = Can Embed Privacy keep external services from tracking me/my visitors? =
35
36 Yes. As long as you don't opt in to load external content, you/your visitors can't be tracked by these services.
37
38 = Does Embed Privacy make embedding content privacy-friendly? =
39
40 The embedding process itself will be privacy-friendly with Embed Privacy. That means, that no third-party embed provider can track users without their explicit consent by clicking on the overlay to allow the embed to be loaded. However, to make sure everything is fine you need to expand your privacy policy for each embed provider you’re using or you want to use because you need to specify, where data will be sent to and what happens to them.
41
42 = Does Embed Privacy use cookies? =
43
44 If you use the opt-out functionality with the shortcode or the functionality to allow the user to always display content of certain embed providers, Embed Privacy creates a single cookie called `embed-privacy` with an expiration of 1 year to store the user’s choice.
45
46 = Does Embed Privacy support the block editor? =
47
48 Sure thing! We enjoy playing with the block editor and developed Embed Privacy with Gutenberg in mind, the plugin will work no matter the editor you use.
49
50 = Which embeds are currently supported? =
51
52 We currently support all oEmbed providers known to WordPress core by default. Want to know about them? Here you go:
53
54 * Amazon Kindle
55 * Anghami
56 * Animoto
57 * Cloudup
58 * DailyMotion
59 * Facebook
60 * Flickr
61 * Funny Or Die
62 * Imgur
63 * Instagram
64 * Issuu
65 * Kickstarter
66 * Meetup
67 * Mixcloud
68 * Photobucket
69 * Pocket Casts
70 * Polldaddy.com
71 * Reddit
72 * ReverbNation
73 * Scribd
74 * Sketchfab
75 * SlideShare
76 * SmugMug
77 * SoundCloud
78 * Speaker Deck
79 * Spotify
80 * TikTok
81 * TED
82 * Tumblr
83 * Twitter
84 * VideoPress
85 * Vimeo
86 * WordPress.org
87 * WordPress.tv
88 * YouTube
89
90 We also support Google Maps via iframe and the plugins Maps Marker, Maps Marker Pro and Shortcodes Ultimate.
91
92 Since version 1.2.0, you can also add custom embed providers by going to **Settings > Embed Privacy > Manage embeds**. Here you can also modify any existing embed provider, change its logo, add a background image, change the text displaying on the embed or disable the embed provider entirely.
93
94 = Can Embed Privacy automatically download thumbnails of the embedded content? =
95
96 Yes! Since version 1.5.0, Embed Privacy supports downloading and displaying thumbnails in posts for SlideShare, Vimeo and YouTube as background of Embed Privacy’s overlay.
97
98 = Can users opt-out of already opted in embed providers? =
99
100 Yes! You can use the shortcode `[embed_privacy_opt_out]` to add a list of embed providers anywhere you want (recommendation: add it to your privacy policy) to allow your users to opt-out.
101
102 = What parameters can be used in the shortcode? =
103
104 The shortcode `[embed_privacy_opt_out]` can be used to let users opt-out of embed providers that have been set to be always active by the user. It can have the following attributes:
105
106 <code>headline</code> – Add a custom headline (default: Embed providers)
107
108 `
109 [embed_privacy_opt_out headline="My custom headline"]
110 `
111
112 <code>subline</code> – Add a custom subline (default: Enable or disable embed providers globally. By enabling a provider, its embedded content will be displayed directly on every page without asking you anymore.)
113
114 `
115 [embed_privacy_opt_out subline="My custom subline"]
116 `
117
118 <code>show_all</code> – Whether to show all available embed providers or just the ones the user opted in (default: false)
119
120 `
121 [embed_privacy_opt_out show_all="1"]
122 `
123
124 You can also combine all of these attributes:
125
126 `
127 [embed_privacy_opt_out headline="My custom headline" subline="My custom subline" show_all="1"]
128 `
129
130 = Is this plugin compatible with my caching plugin? =
131
132 If you’re using a caching plugin, make sure you enable the "JavaScript detection for active providers" in **Settings > Embed Privacy > JavaScript detection**. Then, the plugin is fully compatible with your caching plugin.
133
134 = How can Embed Privacy be extended? =
135
136 Check out our documentation: [https://epiph.yt/en/embed-privacy/documentation/](https://epiph.yt/en/embed-privacy/documentation/)
137
138 = Who are you, folks? =
139
140 We are [Epiphyt](https://epiph.yt/), your friendly neighborhood WordPress plugin shop from southern Germany.
141
142 = How can I report security bugs? =
143
144 You can report security bugs through the Patchstack Vulnerability Disclosure Program. The Patchstack team help validate, triage and handle any security vulnerabilities. [Report a security vulnerability.](https://patchstack.com/database/vdp/embed-privacy)
145
146 == Changelog ==
147
148 = 1.10.5 =
149 * Improved: Renamed Twitter to X
150 * Fixed: Check for matching provider
151 * Fixed: Missing assets for YouTube overlay in Elementor
152 * Fixed: Hiding providers in the opt-out shortcodes if desired
153 * Fixed: Potential PHP warning
154
155 = 1.10.4 =
156 * Fixed: Blocking embeds appearing in the same content after a disabled/always active provider
157 * Fixed: Cookie lifetime
158
159 = 1.10.3 =
160 * Fixed: Multiple replacements of the same embed
161 * Fixed: Replacing unknown embeds
162 * Fixed: Always return an embed provider via `Providers::get_by_name()`
163 * Fixed: Warning about potentially non-available asset version
164
165 = 1.10.2 =
166 * Fixed: Potential fatal error for missing check of the availability of the function `is_plugin_active`
167
168 = 1.10.1 =
169 * Fixed: Set correct "Tested up to" to WordPress 6.6
170
171 = 1.10.0 =
172 * Added: Thumbnail support for Polylang
173 * Added: Filter to prevent orphan thumbnail deletion
174 * Added: New style system for an improved markup and valid HTML code
175 * Improved: Shared content to the Fediverse does not contain the overlay anymore
176 * Improved: Made it more clear what the opt-out shortcode does
177 * Fixed: Missing assets on the blog homepage if it contains an embed
178 * For developers: More notices about deprecated code
179 * For developers: Complete rework of the plugin's code (with complete backwards compatibility). See [the migration guide](https://epiph.yt/en/embed-privacy/documentation/migration-to-version-1-10-0/) for more information
180
181 = 1.9.2 =
182 * Improve the text for screen readers upon activating the embedded content
183 * Fixed compatibility with other widget plugins
184 * Fixed handling of videos in Divi
185
186 = 1.9.1 =
187 * Fixed an error while uninstalling the plugin
188 * Fixed aspect ratio of embeds embedded via Divi
189 * Fixed spelling of "SlideShare"
190
191 = 1.9.0 =
192 * Added support for thumbnails for WordPress TV
193 * Added filter to filter embed arguments
194 * Added filter to ignore certain embeds
195 * Improved style generation to improve performance and fix HTML validation
196 * Improved script loading by using `defer` attributes
197 * Fixed certain fields deleted after changing embed provider to draft
198 * Fixed URL encoding after replacements
199
200 = 1.8.1 =
201 * Fixed the output of the opt-out shortcode (thanks wpdabh for reporting)
202
203 = 1.8.0 =
204 * Added support for Anghami
205 * Added filter to prevent thumbnail orphan deletion
206 * Added check for PHP DOM extension
207 * Improved loading embed providers
208
209 = 1.7.3 =
210 * Improved compatibility with Advanced Custom Fields
211 * Fixed compatibility with PHP 8.2
212 * Fixed a potential PHP warning if a post does not exist while checking permissions
213 * Fixed functionality of the opt-out shortcode if the current website uses a non-standard port
214 * Fixed replacing only the necessary part of embedded contents for custom embeds
215 * Fixed replacing all occurrences of a custom embed in the current content
216 * Fixed multiple unnecessary database queries in migration before the actual check whether a migration is necessary
217 * Fixed downloading the thumbnail multiple times when the same embed is embedded multiple times
218 * Fixed deleted thumbnails if they are only in content of Advanced Custom Fields
219 * Fixed a potential security issue regarding disclosing absolute paths in thumbnail URLs (special thanks to [@kraftner](https://profiles.wordpress.org/kraftner/))
220 * Fixed aspect ratio generation if width or height contains a percentage sign
221 * Fixed thumbnail positioning (it's now horizontally and vertically centered)
222 * Fixed HTML output of the opt-out shortcode
223
224 = 1.7.2 =
225 * Fixed getting the URL of video shortcodes properly to not block content from the same (sub)domain
226
227 = 1.7.1 =
228 * Improved Google Maps height in Kadence Blocks
229 * Fixed a JavaScript error if jQuery is not initialized
230 * Fixed potential PHP warning regarding an undefined variable
231 * Fixed potential PHP warning regarding an undefined hostname while retrieving the embed URL
232
233 = 1.7.0 =
234 * Added support for crowdsignal.net
235 * Added support for classic video shortcode/widget
236 * Added support for SlideShare thumbnails (thanks to [@Lazza](https://github.com/Lazza))
237 * Added support for custom thumbnail generation via filter
238 * Fixed hiding thumbnails after embedded content has been enabled
239 * Fixed aspect ratio for embeds without proper dimension information
240
241 = 1.6.5 =
242 * Fixed aspect ratio for non-default content width themes
243 * Fixed handling of the % character
244
245 = 1.6.4 =
246 * Fixed aspect ratio for many oEmbeds
247
248 = 1.6.3 =
249 * Fixed replacing some oEmbeds
250 * Fixed potential problems while retrieving a single embed provider
251 * Fixed deleting post metadata of embed providers while editing them via WP-CLI
252
253 = 1.6.2 =
254 * Restore displaying YouTube thumbnails
255
256 = 1.6.1 =
257 * Updated required WordPress version to 5.0
258 * Fixed text links to youtube.com
259 * Fixed Twitter embeds
260
261 = 1.6.0 =
262 * Added automatic detection of aspect ratio if given by the embed
263 * Added ability to work with HTML of regular oEmbed providers
264 * Added filter to ignore shortcodes (see [documentation](https://epiph.yt/en/embed-privacy/documentation/#embed_privacy_ignored_shortcodes))
265 * Added matching links to the new documentation at [https://epiph.yt/en/embed-privacy/documentation/](https://epiph.yt/en/embed-privacy/documentation/)
266 * Improved handling of matching non-standard elements (embed, iframe, object, see [documentation](https://epiph.yt/en/embed-privacy/documentation/#regex-pattern))
267 * Fixed Google Maps regex pattern after installation
268 * Fixed behavior of the opt-out shortcode with enabled page caching
269 * Fixed line-height of custom embeds in Elementor
270 * General code improvements
271
272 = 1.5.1 =
273 * Fixed storing and displaying video thumbnails from Vimeo that are embedded using the domain player.vimeo.com
274 * Fixed unnecessary line breaks within the classic editor
275 * Fixed displaying the overlay if an embed of a known embed provider followed an embed of an unknown embed provider
276 * Fixed uninstallation issues
277
278 = 1.5.0 =
279 * Added support for embed provider Pocket Casts
280 * Added support for Maps Marker and Maps Marker Pro
281 * Added support for Google Maps in Shortcodes Ultimate
282 * Added support to automatically download and display a thumbnail of the embed for Vimeo and YouTube (only in posts)
283 * Added support to re-initiate the database migration and display an error message if it has been failed at least three times
284 * Added support for Polylang and Polylang Pro
285 * Added a new filter to allow stopping Embed Privacy from handling unknown embeds
286 * Added option to disable the direct link in the overlay
287 * Updated logos for Reddit, SmugMug and SoundCloud for better readability
288 * Use the plugin version as parameter for assets to allow better caching and prevent problems with some setups
289 * General code improvements
290 * Fixed a JavaScript error
291
292 = 1.4.8 =
293 * Fixed an issue with always active providers being cached by page caching plugins
294 * Fixed printing inline JavaScript only once
295
296 = 1.4.7 =
297 * Fixed displaying embeds on mobile devices while using Divi
298 * Fixed the output of assets
299 * Improved regular expression for Google Maps
300
301 = 1.4.6 =
302 * Fixed an issue where JavaScript assets may be missing for the opt-out shortcode
303
304 = 1.4.5 =
305 * Fixed an issue with always enable an unknown embed provider
306 * Fixed issues with missing JavaScript for Facebook embed of Jetpack
307
308 = 1.4.4 =
309 * Fixed a potential encoding issue
310 * Fixed issues with Facebook embed of Jetpack
311 * Fixed issues with registering assets
312
313 = 1.4.3 =
314 * Fixed a problem that prevents embed fields from being stored
315
316 = 1.4.2 =
317 * Fixed an expired link during plugin activation and creating a new embed provider
318
319 = 1.4.1 =
320 * Fixed invalid HTML by changing the accessibility behavior (it's now a separate button)
321 * Fixed potential empty link titles in other locales then English
322 * Fixed potential unwanted URL encoding in the content after Embed Privacy replaced an embed
323
324 = 1.4.0 =
325 * Added support for Pinterest and Wolfram Cloud
326 * Improved migrations to fix duplicate providers or performance problems in multisite installations
327 * Embeds can now be enabled via keyboard
328 * Added a link to the original content on the bottom right overlay corner
329 * Added support for caching the opt-out shortcode
330 * Clicking on the "always enable content of X" enables all embeds of this provider on the current page immediately
331 * Improved markup of local tweets
332 * Added additional class to checkbox paragraph, thanks to @florianbrinkmann
333 * System providers cannot be deleted anymore
334 * Fixed oEmbed provider name if the provider is unknown
335 * Fix enqueuing assets for unknown embed providers
336
337 = 1.3.6 =
338 * Fixed enabling multiple YouTube videos in Elementor
339 * Fixed displaying content if the page contains an always active provider
340
341 = 1.3.5 =
342 * Fixed functionality in Elementor
343 * Fixed custom embed provider output
344 * Fixed replacing content in shortcodes multiple times
345 * Fixed checking for theme/template
346
347 = 1.3.4 =
348 * Fixed deleted meta fields if you put an embed provider in trash and restore it afterwards
349 * Fixed Embed Privacy sometimes trying to replace an embed twice
350 * Fixed an error that may occur if Embed Privacy tries to replace an embed that doesn't need to be replaced
351 * Fixed checking for local domain if WordPress itself is located in a sub-domain
352 * Fixed always enable YouTube within Divi
353 * Fixed overlay line height in Divi
354
355 = 1.3.3 =
356 * Improved mobile design for responsive embeds
357 * Fixed centering for non-responsive embeds
358 * Fixed disabled embed content from preventing interactions with the text below the overlay
359
360 = 1.3.2 =
361 * Fixed general activation error
362
363 = 1.3.1 =
364 * Fixed a fatal error on uninstallation on non-multisite
365 * Fixed activating via WP-CLI
366 * Fixed deleting an option on uninstallation
367
368 = 1.3.0 =
369 * Added local tweets without overlay
370 * Added option to preserve data on uninstall
371 * Added compatibility with theme Astra
372 * Added filter `embed_privacy_markup` for filtering the whole markup of an embed overlay
373 * Added proper support for embeds on the current domain
374 * Added support for embeds on other elements than `embed`, `iframe` and `object`
375 * Enqueue assets only if needed
376 * Removed images from media (which had been added in version 1.2.0) and use fallback images for default embed providers
377 * Improved regular expression for Google Maps
378 * Improved texts for clarity
379 * Fixed visibility of custom post type
380 * Fixed network-wide activation
381 * Fixed clearing oEmbed cache
382
383 = 1.2.2 =
384 * Added a check if a migration is already running
385 * Fixed a bug where the page markup could be changed unexpectedly
386 * `<object>` elements are now replaced correctly
387 * Added a missing textdomain to a string
388 * Excluded local embeds (with the same domain)
389 * Fixed Amazon Kindle regex being too greedy
390
391 = 1.2.1 =
392 * Fixed a bug where the page markup could be changed unexpectedly
393 * Fixed a warning if an embed provider has no regular expressions
394 * Improved migrations of embed provider metadata to make sure they have been added to the database
395
396 = 1.2.0 =
397 * Added support for managing embeds (add/remove/edit/disable)
398 * Added support for caching plugins by adding a JavaScript detection for always active embed providers
399 * Added CSS classes that indicate the current state of the embed (`is-disabled`/`is-enabled`)
400 * Added shortcode `[embed_privacy_opt_out]` to allow users to opt-out/in
401 * Fixed responsive design if the embed added an own width
402
403 = 1.1.3 =
404 * Changed provider name from Polldaddy to Crowdsignal
405 * Removed provider Hulu
406
407 = 1.1.2 =
408 * Fixed a possible difference in the used class name of the embed provider in HTML and CSS
409
410 = 1.1.1 =
411 * Removed provider CollegeHumor
412 * Fixed a bug with the automatic addition of paragraphs
413
414 = 1.1.0 =
415 * Added option to allow all embeds by one provider
416 * Added provider TikTok, introduced in WordPress 5.4
417 * Added support for Google Maps iframes
418 * Added URL rewrite to youtube-nocookie.com
419 * Added option to save user selection per embed provider
420 * Added provider logo to our placeholder
421 * Added option to filter our placeholders markup
422 * Added support for 'alignwide' and 'alignfull' Gutenberg classes
423 * Added support for using our embedding overlay mechanism for external developers
424 * Improved our placeholder markup to be actually semantic
425 * Changed .embed- classes to .embed-privacy-
426 * Fixed some embed providers that use custom z-index, which results in the embedded content being above the overlay
427 * Fixed typos
428
429 = 1.0.2 =
430 * Improved compatibility with [Autoptimize](https://wordpress.org/plugins/autoptimize/)
431 * Improved compatibility with [AMP](https://wordpress.org/plugins/amp/)
432 * Fix issue with SlideShare causing wrong (generic) placeholders
433
434 = 1.0.1 =
435 * Fixed support for PHP 5.6
436
437 = 1.0.0 =
438 * Initial release
439
440 == Upgrade Notice ==
441
442 == Screenshots ==
443 1. Add embeds using the classic editor or the block editor's embed blocks.
444 2. Embed Privacy will add an overlay to supported embeds automatically.
445 3. You can customize the overlays for each service individually.
446 4. Different settings allow you to adjust the functionality of Embed Privacy according to your needs.
447