PluginProbe
Embed Privacy / 1.11.0
Embed Privacy v1.11.0
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.0, at readme.txt

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