PluginProbe
Embed Privacy / 1.11.2
Embed Privacy v1.11.2
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.11.2, at readme.txt

515 lines 21.1 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.11.2
6 Tested up to: 6.8
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 * Bluesky
58 * Canva
59 * Cloudup
60 * DailyMotion
61 * Facebook
62 * Flickr
63 * Funny Or Die
64 * Imgur
65 * Instagram
66 * Issuu
67 * Kickstarter
68 * Meetup
69 * Mixcloud
70 * Photobucket
71 * Pocket Casts
72 * Polldaddy.com
73 * Reddit
74 * ReverbNation
75 * Scribd
76 * Sketchfab
77 * SlideShare
78 * SmugMug
79 * SoundCloud
80 * Speaker Deck
81 * Spotify
82 * TikTok
83 * TED
84 * Tumblr
85 * Twitter
86 * VideoPress
87 * Vimeo
88 * WordPress.org
89 * WordPress.tv
90 * YouTube
91
92 We also support Google Maps via iframe and Divi and the following plugins:
93
94 * BuddyPress activity stream
95 * Jetpack (Facebook posts)
96 * Maps Marker (Pro)
97 * Shortcodes Ultimate
98 * wpForo (with the plugin wpForo Embeds)
99
100 Additionally, we support the following custom content:
101
102 * Local Fediverse content
103 * Local X posts
104 * Facebook embed code (HTML)
105 * Instagram embed code (HTML)
106
107 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.
108
109 = Can Embed Privacy automatically download thumbnails of the embedded content? =
110
111 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.
112
113 = Can users opt-out of already opted in embed providers? =
114
115 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.
116
117 = What parameters can be used in the shortcode? =
118
119 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:
120
121 <code>headline</code> – Add a custom headline (default: Embed providers)
122
123 `
124 [embed_privacy_opt_out headline="My custom headline"]
125 `
126
127 <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.)
128
129 `
130 [embed_privacy_opt_out subline="My custom subline"]
131 `
132
133 <code>show_all</code> – Whether to show all available embed providers or just the ones the user opted in (default: false)
134
135 `
136 [embed_privacy_opt_out show_all="1"]
137 `
138
139 You can also combine all of these attributes:
140
141 `
142 [embed_privacy_opt_out headline="My custom headline" subline="My custom subline" show_all="1"]
143 `
144
145 = Is this plugin compatible with my caching plugin? =
146
147 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.
148
149 = How can Embed Privacy be extended? =
150
151 Check out our documentation: [https://epiph.yt/en/embed-privacy/documentation/](https://epiph.yt/en/embed-privacy/documentation/)
152
153 = Who are you, folks? =
154
155 We are [Epiphyt](https://epiph.yt/en/), your friendly neighborhood WordPress plugin shop from southern Germany.
156
157 = How can I report security bugs? =
158
159 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)
160
161 == Changelog ==
162
163 = 1.11.2 =
164 * Improved: YouTube support in Elementor (settings are now supported as well as youtu.be domain, styling has been improved)
165 * Fixed: Replacing embeds on blog page
166 * Fixed: Embed in feeds now display only a link to the content instead of a non-working overlay
167
168 = 1.11.1 =
169 * Improved: Class autoloading performance
170 * Improved: Allow overriding `EPI_EMBED_PRIVACY_BASE` constant
171 * Improved: Replaced `url_to_postid` with a shortcode usage check in the content
172 * Fixed: JavaScript error on clicking an opt-out checkbox
173 * Fixed: Don't use deprecated parameter of Style class
174 * Fixed: Erroneous overlay replacements in certain circumstances
175
176 = 1.11.0 =
177 * Added: Support for embed provider Bluesky
178 * Added: Support for embed provider Canva
179 * Added: Support for local ActivityPub posts
180 * Added: Support for BuddyPress activity stream
181 * Added: Support for Facebook and Instagram HTML embed codes
182 * Added: Support for wpForo Embeds
183 * Added: Defining the term for the content direct link or disabling it altogether
184 * Added: Support area to easily copy data for support
185 * Improved: After enabling an embed, the content now receives focus
186 * Improved: Link names for privacy policy now include the service's name
187 * Fixed: Support for Embed Privacy being installed via MU plugin directory
188 * Developers: [Migration guide](https://epiph.yt/en/embed-privacy/documentation/migration-to-version-1-11-0/)
189
190 = 1.10.10 =
191 * Fixed: Loading Google Maps in Divi
192 * Fixed: Replacing HTML elements with regular expressions
193 * Fixed: Falsely-negative detection of ActivityPub usage
194
195 = 1.10.9 =
196 * Fixed: Recognition for Twitter/X embeds
197 * Fixed: Output of the Instagram Feed plugin is replaced with an faulty overlay
198 * Fixed: Displaying embeds in Divi’s dynamic content
199
200 = 1.10.8 =
201 * Fixed: An undefined variable in the shortcode output
202
203 = 1.10.7 =
204 * Fixed: Custom background images and logos
205 * Fixed: Direct link to YouTube videos
206 * Fixed: Handling of non-available YouTube videos
207 * Fixed: Replacing URLs inside attributes
208 * Fixed: Invalid HTML
209 * Fixed: Replacing URLs ending with x.com
210 * Fixed: Displaying always active providers
211
212 = 1.10.6 =
213 * Fixed: Detection for unknown embeds
214 * Fixed: Detection for Maps Marker Pro
215
216 = 1.10.5 =
217 * Improved: Renamed Twitter to X
218 * Fixed: Check for matching provider
219 * Fixed: Missing assets for YouTube overlay in Elementor
220 * Fixed: Hiding providers in the opt-out shortcodes if desired
221 * Fixed: Potential PHP warning
222
223 = 1.10.4 =
224 * Fixed: Blocking embeds appearing in the same content after a disabled/always active provider
225 * Fixed: Cookie lifetime
226
227 = 1.10.3 =
228 * Fixed: Multiple replacements of the same embed
229 * Fixed: Replacing unknown embeds
230 * Fixed: Always return an embed provider via `Providers::get_by_name()`
231 * Fixed: Warning about potentially non-available asset version
232
233 = 1.10.2 =
234 * Fixed: Potential fatal error for missing check of the availability of the function `is_plugin_active`
235
236 = 1.10.1 =
237 * Fixed: Set correct "Tested up to" to WordPress 6.6
238
239 = 1.10.0 =
240 * Added: Thumbnail support for Polylang
241 * Added: Filter to prevent orphan thumbnail deletion
242 * Added: New style system for an improved markup and valid HTML code
243 * Improved: Shared content to the Fediverse does not contain the overlay anymore
244 * Improved: Made it more clear what the opt-out shortcode does
245 * Fixed: Missing assets on the blog homepage if it contains an embed
246 * For developers: More notices about deprecated code
247 * 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
248
249 = 1.9.2 =
250 * Improve the text for screen readers upon activating the embedded content
251 * Fixed compatibility with other widget plugins
252 * Fixed handling of videos in Divi
253
254 = 1.9.1 =
255 * Fixed an error while uninstalling the plugin
256 * Fixed aspect ratio of embeds embedded via Divi
257 * Fixed spelling of "SlideShare"
258
259 = 1.9.0 =
260 * Added support for thumbnails for WordPress TV
261 * Added filter to filter embed arguments
262 * Added filter to ignore certain embeds
263 * Improved style generation to improve performance and fix HTML validation
264 * Improved script loading by using `defer` attributes
265 * Fixed certain fields deleted after changing embed provider to draft
266 * Fixed URL encoding after replacements
267
268 = 1.8.1 =
269 * Fixed the output of the opt-out shortcode (thanks wpdabh for reporting)
270
271 = 1.8.0 =
272 * Added support for Anghami
273 * Added filter to prevent thumbnail orphan deletion
274 * Added check for PHP DOM extension
275 * Improved loading embed providers
276
277 = 1.7.3 =
278 * Improved compatibility with Advanced Custom Fields
279 * Fixed compatibility with PHP 8.2
280 * Fixed a potential PHP warning if a post does not exist while checking permissions
281 * Fixed functionality of the opt-out shortcode if the current website uses a non-standard port
282 * Fixed replacing only the necessary part of embedded contents for custom embeds
283 * Fixed replacing all occurrences of a custom embed in the current content
284 * Fixed multiple unnecessary database queries in migration before the actual check whether a migration is necessary
285 * Fixed downloading the thumbnail multiple times when the same embed is embedded multiple times
286 * Fixed deleted thumbnails if they are only in content of Advanced Custom Fields
287 * Fixed a potential security issue regarding disclosing absolute paths in thumbnail URLs (special thanks to [@kraftner](https://profiles.wordpress.org/kraftner/))
288 * Fixed aspect ratio generation if width or height contains a percentage sign
289 * Fixed thumbnail positioning (it's now horizontally and vertically centered)
290 * Fixed HTML output of the opt-out shortcode
291
292 = 1.7.2 =
293 * Fixed getting the URL of video shortcodes properly to not block content from the same (sub)domain
294
295 = 1.7.1 =
296 * Improved Google Maps height in Kadence Blocks
297 * Fixed a JavaScript error if jQuery is not initialized
298 * Fixed potential PHP warning regarding an undefined variable
299 * Fixed potential PHP warning regarding an undefined hostname while retrieving the embed URL
300
301 = 1.7.0 =
302 * Added support for crowdsignal.net
303 * Added support for classic video shortcode/widget
304 * Added support for SlideShare thumbnails (thanks to [@Lazza](https://github.com/Lazza))
305 * Added support for custom thumbnail generation via filter
306 * Fixed hiding thumbnails after embedded content has been enabled
307 * Fixed aspect ratio for embeds without proper dimension information
308
309 = 1.6.5 =
310 * Fixed aspect ratio for non-default content width themes
311 * Fixed handling of the % character
312
313 = 1.6.4 =
314 * Fixed aspect ratio for many oEmbeds
315
316 = 1.6.3 =
317 * Fixed replacing some oEmbeds
318 * Fixed potential problems while retrieving a single embed provider
319 * Fixed deleting post metadata of embed providers while editing them via WP-CLI
320
321 = 1.6.2 =
322 * Restore displaying YouTube thumbnails
323
324 = 1.6.1 =
325 * Updated required WordPress version to 5.0
326 * Fixed text links to youtube.com
327 * Fixed Twitter embeds
328
329 = 1.6.0 =
330 * Added automatic detection of aspect ratio if given by the embed
331 * Added ability to work with HTML of regular oEmbed providers
332 * Added filter to ignore shortcodes (see [documentation](https://epiph.yt/en/embed-privacy/documentation/#embed_privacy_ignored_shortcodes))
333 * Added matching links to the new documentation at [https://epiph.yt/en/embed-privacy/documentation/](https://epiph.yt/en/embed-privacy/documentation/)
334 * Improved handling of matching non-standard elements (embed, iframe, object, see [documentation](https://epiph.yt/en/embed-privacy/documentation/#regex-pattern))
335 * Fixed Google Maps regex pattern after installation
336 * Fixed behavior of the opt-out shortcode with enabled page caching
337 * Fixed line-height of custom embeds in Elementor
338 * General code improvements
339
340 = 1.5.1 =
341 * Fixed storing and displaying video thumbnails from Vimeo that are embedded using the domain player.vimeo.com
342 * Fixed unnecessary line breaks within the classic editor
343 * Fixed displaying the overlay if an embed of a known embed provider followed an embed of an unknown embed provider
344 * Fixed uninstallation issues
345
346 = 1.5.0 =
347 * Added support for embed provider Pocket Casts
348 * Added support for Maps Marker and Maps Marker Pro
349 * Added support for Google Maps in Shortcodes Ultimate
350 * Added support to automatically download and display a thumbnail of the embed for Vimeo and YouTube (only in posts)
351 * Added support to re-initiate the database migration and display an error message if it has been failed at least three times
352 * Added support for Polylang and Polylang Pro
353 * Added a new filter to allow stopping Embed Privacy from handling unknown embeds
354 * Added option to disable the direct link in the overlay
355 * Updated logos for Reddit, SmugMug and SoundCloud for better readability
356 * Use the plugin version as parameter for assets to allow better caching and prevent problems with some setups
357 * General code improvements
358 * Fixed a JavaScript error
359
360 = 1.4.8 =
361 * Fixed an issue with always active providers being cached by page caching plugins
362 * Fixed printing inline JavaScript only once
363
364 = 1.4.7 =
365 * Fixed displaying embeds on mobile devices while using Divi
366 * Fixed the output of assets
367 * Improved regular expression for Google Maps
368
369 = 1.4.6 =
370 * Fixed an issue where JavaScript assets may be missing for the opt-out shortcode
371
372 = 1.4.5 =
373 * Fixed an issue with always enable an unknown embed provider
374 * Fixed issues with missing JavaScript for Facebook embed of Jetpack
375
376 = 1.4.4 =
377 * Fixed a potential encoding issue
378 * Fixed issues with Facebook embed of Jetpack
379 * Fixed issues with registering assets
380
381 = 1.4.3 =
382 * Fixed a problem that prevents embed fields from being stored
383
384 = 1.4.2 =
385 * Fixed an expired link during plugin activation and creating a new embed provider
386
387 = 1.4.1 =
388 * Fixed invalid HTML by changing the accessibility behavior (it's now a separate button)
389 * Fixed potential empty link titles in other locales then English
390 * Fixed potential unwanted URL encoding in the content after Embed Privacy replaced an embed
391
392 = 1.4.0 =
393 * Added support for Pinterest and Wolfram Cloud
394 * Improved migrations to fix duplicate providers or performance problems in multisite installations
395 * Embeds can now be enabled via keyboard
396 * Added a link to the original content on the bottom right overlay corner
397 * Added support for caching the opt-out shortcode
398 * Clicking on the "always enable content of X" enables all embeds of this provider on the current page immediately
399 * Improved markup of local tweets
400 * Added additional class to checkbox paragraph, thanks to @florianbrinkmann
401 * System providers cannot be deleted anymore
402 * Fixed oEmbed provider name if the provider is unknown
403 * Fix enqueuing assets for unknown embed providers
404
405 = 1.3.6 =
406 * Fixed enabling multiple YouTube videos in Elementor
407 * Fixed displaying content if the page contains an always active provider
408
409 = 1.3.5 =
410 * Fixed functionality in Elementor
411 * Fixed custom embed provider output
412 * Fixed replacing content in shortcodes multiple times
413 * Fixed checking for theme/template
414
415 = 1.3.4 =
416 * Fixed deleted meta fields if you put an embed provider in trash and restore it afterwards
417 * Fixed Embed Privacy sometimes trying to replace an embed twice
418 * Fixed an error that may occur if Embed Privacy tries to replace an embed that doesn't need to be replaced
419 * Fixed checking for local domain if WordPress itself is located in a sub-domain
420 * Fixed always enable YouTube within Divi
421 * Fixed overlay line height in Divi
422
423 = 1.3.3 =
424 * Improved mobile design for responsive embeds
425 * Fixed centering for non-responsive embeds
426 * Fixed disabled embed content from preventing interactions with the text below the overlay
427
428 = 1.3.2 =
429 * Fixed general activation error
430
431 = 1.3.1 =
432 * Fixed a fatal error on uninstallation on non-multisite
433 * Fixed activating via WP-CLI
434 * Fixed deleting an option on uninstallation
435
436 = 1.3.0 =
437 * Added local tweets without overlay
438 * Added option to preserve data on uninstall
439 * Added compatibility with theme Astra
440 * Added filter `embed_privacy_markup` for filtering the whole markup of an embed overlay
441 * Added proper support for embeds on the current domain
442 * Added support for embeds on other elements than `embed`, `iframe` and `object`
443 * Enqueue assets only if needed
444 * Removed images from media (which had been added in version 1.2.0) and use fallback images for default embed providers
445 * Improved regular expression for Google Maps
446 * Improved texts for clarity
447 * Fixed visibility of custom post type
448 * Fixed network-wide activation
449 * Fixed clearing oEmbed cache
450
451 = 1.2.2 =
452 * Added a check if a migration is already running
453 * Fixed a bug where the page markup could be changed unexpectedly
454 * `<object>` elements are now replaced correctly
455 * Added a missing textdomain to a string
456 * Excluded local embeds (with the same domain)
457 * Fixed Amazon Kindle regex being too greedy
458
459 = 1.2.1 =
460 * Fixed a bug where the page markup could be changed unexpectedly
461 * Fixed a warning if an embed provider has no regular expressions
462 * Improved migrations of embed provider metadata to make sure they have been added to the database
463
464 = 1.2.0 =
465 * Added support for managing embeds (add/remove/edit/disable)
466 * Added support for caching plugins by adding a JavaScript detection for always active embed providers
467 * Added CSS classes that indicate the current state of the embed (`is-disabled`/`is-enabled`)
468 * Added shortcode `[embed_privacy_opt_out]` to allow users to opt-out/in
469 * Fixed responsive design if the embed added an own width
470
471 = 1.1.3 =
472 * Changed provider name from Polldaddy to Crowdsignal
473 * Removed provider Hulu
474
475 = 1.1.2 =
476 * Fixed a possible difference in the used class name of the embed provider in HTML and CSS
477
478 = 1.1.1 =
479 * Removed provider CollegeHumor
480 * Fixed a bug with the automatic addition of paragraphs
481
482 = 1.1.0 =
483 * Added option to allow all embeds by one provider
484 * Added provider TikTok, introduced in WordPress 5.4
485 * Added support for Google Maps iframes
486 * Added URL rewrite to youtube-nocookie.com
487 * Added option to save user selection per embed provider
488 * Added provider logo to our placeholder
489 * Added option to filter our placeholders markup
490 * Added support for 'alignwide' and 'alignfull' Gutenberg classes
491 * Added support for using our embedding overlay mechanism for external developers
492 * Improved our placeholder markup to be actually semantic
493 * Changed .embed- classes to .embed-privacy-
494 * Fixed some embed providers that use custom z-index, which results in the embedded content being above the overlay
495 * Fixed typos
496
497 = 1.0.2 =
498 * Improved compatibility with [Autoptimize](https://wordpress.org/plugins/autoptimize/)
499 * Improved compatibility with [AMP](https://wordpress.org/plugins/amp/)
500 * Fix issue with SlideShare causing wrong (generic) placeholders
501
502 = 1.0.1 =
503 * Fixed support for PHP 5.6
504
505 = 1.0.0 =
506 * Initial release
507
508 == Upgrade Notice ==
509
510 == Screenshots ==
511 1. Add embeds using the classic editor or the block editor's embed blocks.
512 2. Embed Privacy will add an overlay to supported embeds automatically.
513 3. You can customize the overlays for each service individually.
514 4. Different settings allow you to adjust the functionality of Embed Privacy according to your needs.
515