PluginProbe
Embed Privacy / 1.10.0
Embed Privacy v1.10.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.10.0, at readme.txt

456 lines 18.9 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
4 Requires at least: 5.9
5 Stable tag: 1.10.0
6 Tested up to: 6.5
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 Gutenberg editor? =
47
48 Sure thing! We enjoy playing with the new WordPress 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 = Developers: How to use Embed Privacy’s methods for custom content? =
99
100 Since version 1.1.0 you can now use our mechanism for content we don’t support in our plugin. You can do it the following way:
101
102 `
103 /**
104 * Replace specific content with the Embed Privacy overlay of type 'google-maps'.
105 *
106 * @param string $content The content to replace
107 * @return string The updated content
108 */
109 function prefix_replace_content_with_overlay( $content ) {
110 // check for Embed Privacy
111 if ( ! class_exists( 'epiphyt\Embed_Privacy\Embed_Privacy' ) ) {
112 return $content;
113 }
114
115 // get Embed Privacy instance
116 $embed_privacy = epiphyt\Embed_Privacy\Embed_Privacy::get_instance();
117
118 // check if provider is always active; if so, just return the content
119 if ( ! $embed_privacy->is_always_active_provider( 'google-maps' ) ) {
120 // replace the content with the overlay
121 $content = $embed_privacy->get_output_template( 'Google Maps', 'google-maps', $content );
122 // enqueue assets
123 $embed_privacy->print_assets();
124 }
125
126 return $content;
127 }
128 `
129
130 = Can users opt-out of already opted in embed providers? =
131
132 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.
133
134 = What parameters can be used in the shortcode? =
135
136 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:
137
138 <code>headline</code> – Add a custom headline (default: Embed providers)
139
140 `
141 [embed_privacy_opt_out headline="My custom headline"]
142 `
143
144 <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.)
145
146 `
147 [embed_privacy_opt_out subline="My custom subline"]
148 `
149
150 <code>show_all</code> – Whether to show all available embed providers or just the ones the user opted in (default: false)
151
152 `
153 [embed_privacy_opt_out show_all="1"]
154 `
155
156 You can also combine all of these attributes:
157
158 `
159 [embed_privacy_opt_out headline="My custom headline" subline="My custom subline" show_all="1"]
160 `
161
162 = Is this plugin compatible with my caching plugin? =
163
164 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.
165
166 = How can Embed Privacy be extended? =
167
168 Check out our documentation: [https://epiph.yt/en/embed-privacy/documentation/](https://epiph.yt/en/embed-privacy/documentation/)
169
170 = Who are you, folks? =
171
172 We are [Epiphyt](https://epiph.yt/), your friendly neighborhood WordPress plugin shop from southern Germany.
173
174 = How can I report security bugs? =
175
176 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)
177
178 == Changelog ==
179
180 = 1.10.0 =
181 * Added: Thumbnail support for Polylang
182 * Added: Filter to prevent orphan thumbnail deletion
183 * Added: New style system for an improved markup and valid HTML code
184 * Improved: Shared content to the Fediverse does not contain the overlay anymore
185 * Improved: Made it more clear what the opt-out shortcode does
186 * Fixed: Missing assets on the blog homepage if it contains an embed
187 * For developers: More notices about deprecated code
188 * 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
189
190 = 1.9.2 =
191 * Improve the text for screen readers upon activating the embedded content
192 * Fixed compatibility with other widget plugins
193 * Fixed handling of videos in Divi
194
195 = 1.9.1 =
196 * Fixed an error while uninstalling the plugin
197 * Fixed aspect ratio of embeds embedded via Divi
198 * Fixed spelling of "SlideShare"
199
200 = 1.9.0 =
201 * Added support for thumbnails for WordPress TV
202 * Added filter to filter embed arguments
203 * Added filter to ignore certain embeds
204 * Improved style generation to improve performance and fix HTML validation
205 * Improved script loading by using `defer` attributes
206 * Fixed certain fields deleted after changing embed provider to draft
207 * Fixed URL encoding after replacements
208
209 = 1.8.1 =
210 * Fixed the output of the opt-out shortcode (thanks wpdabh for reporting)
211
212 = 1.8.0 =
213 * Added support for Anghami
214 * Added filter to prevent thumbnail orphan deletion
215 * Added check for PHP DOM extension
216 * Improved loading embed providers
217
218 = 1.7.3 =
219 * Improved compatibility with Advanced Custom Fields
220 * Fixed compatibility with PHP 8.2
221 * Fixed a potential PHP warning if a post does not exist while checking permissions
222 * Fixed functionality of the opt-out shortcode if the current website uses a non-standard port
223 * Fixed replacing only the necessary part of embedded contents for custom embeds
224 * Fixed replacing all occurrences of a custom embed in the current content
225 * Fixed multiple unnecessary database queries in migration before the actual check whether a migration is necessary
226 * Fixed downloading the thumbnail multiple times when the same embed is embedded multiple times
227 * Fixed deleted thumbnails if they are only in content of Advanced Custom Fields
228 * Fixed a potential security issue regarding disclosing absolute paths in thumbnail URLs (special thanks to [@kraftner](https://profiles.wordpress.org/kraftner/))
229 * Fixed aspect ratio generation if width or height contains a percentage sign
230 * Fixed thumbnail positioning (it's now horizontally and vertically centered)
231 * Fixed HTML output of the opt-out shortcode
232
233 = 1.7.2 =
234 * Fixed getting the URL of video shortcodes properly to not block content from the same (sub)domain
235
236 = 1.7.1 =
237 * Improved Google Maps height in Kadence Blocks
238 * Fixed a JavaScript error if jQuery is not initialized
239 * Fixed potential PHP warning regarding an undefined variable
240 * Fixed potential PHP warning regarding an undefined hostname while retrieving the embed URL
241
242 = 1.7.0 =
243 * Added support for crowdsignal.net
244 * Added support for classic video shortcode/widget
245 * Added support for SlideShare thumbnails (thanks to [@Lazza](https://github.com/Lazza))
246 * Added support for custom thumbnail generation via filter
247 * Fixed hiding thumbnails after embedded content has been enabled
248 * Fixed aspect ratio for embeds without proper dimension information
249
250 = 1.6.5 =
251 * Fixed aspect ratio for non-default content width themes
252 * Fixed handling of the % character
253
254 = 1.6.4 =
255 * Fixed aspect ratio for many oEmbeds
256
257 = 1.6.3 =
258 * Fixed replacing some oEmbeds
259 * Fixed potential problems while retrieving a single embed provider
260 * Fixed deleting post metadata of embed providers while editing them via WP-CLI
261
262 = 1.6.2 =
263 * Restore displaying YouTube thumbnails
264
265 = 1.6.1 =
266 * Updated required WordPress version to 5.0
267 * Fixed text links to youtube.com
268 * Fixed Twitter embeds
269
270 = 1.6.0 =
271 * Added automatic detection of aspect ratio if given by the embed
272 * Added ability to work with HTML of regular oEmbed providers
273 * Added filter to ignore shortcodes (see [documentation](https://epiph.yt/en/embed-privacy/documentation/#embed_privacy_ignored_shortcodes))
274 * Added matching links to the new documentation at [https://epiph.yt/en/embed-privacy/documentation/](https://epiph.yt/en/embed-privacy/documentation/)
275 * Improved handling of matching non-standard elements (embed, iframe, object, see [documentation](https://epiph.yt/en/embed-privacy/documentation/#regex-pattern))
276 * Fixed Google Maps regex pattern after installation
277 * Fixed behavior of the opt-out shortcode with enabled page caching
278 * Fixed line-height of custom embeds in Elementor
279 * General code improvements
280
281 = 1.5.1 =
282 * Fixed storing and displaying video thumbnails from Vimeo that are embedded using the domain player.vimeo.com
283 * Fixed unnecessary line breaks within the classic editor
284 * Fixed displaying the overlay if an embed of a known embed provider followed an embed of an unknown embed provider
285 * Fixed uninstallation issues
286
287 = 1.5.0 =
288 * Added support for embed provider Pocket Casts
289 * Added support for Maps Marker and Maps Marker Pro
290 * Added support for Google Maps in Shortcodes Ultimate
291 * Added support to automatically download and display a thumbnail of the embed for Vimeo and YouTube (only in posts)
292 * Added support to re-initiate the database migration and display an error message if it has been failed at least three times
293 * Added support for Polylang and Polylang Pro
294 * Added a new filter to allow stopping Embed Privacy from handling unknown embeds
295 * Added option to disable the direct link in the overlay
296 * Updated logos for Reddit, SmugMug and SoundCloud for better readability
297 * Use the plugin version as parameter for assets to allow better caching and prevent problems with some setups
298 * General code improvements
299 * Fixed a JavaScript error
300
301 = 1.4.8 =
302 * Fixed an issue with always active providers being cached by page caching plugins
303 * Fixed printing inline JavaScript only once
304
305 = 1.4.7 =
306 * Fixed displaying embeds on mobile devices while using Divi
307 * Fixed the output of assets
308 * Improved regular expression for Google Maps
309
310 = 1.4.6 =
311 * Fixed an issue where JavaScript assets may be missing for the opt-out shortcode
312
313 = 1.4.5 =
314 * Fixed an issue with always enable an unknown embed provider
315 * Fixed issues with missing JavaScript for Facebook embed of Jetpack
316
317 = 1.4.4 =
318 * Fixed a potential encoding issue
319 * Fixed issues with Facebook embed of Jetpack
320 * Fixed issues with registering assets
321
322 = 1.4.3 =
323 * Fixed a problem that prevents embed fields from being stored
324
325 = 1.4.2 =
326 * Fixed an expired link during plugin activation and creating a new embed provider
327
328 = 1.4.1 =
329 * Fixed invalid HTML by changing the accessibility behavior (it's now a separate button)
330 * Fixed potential empty link titles in other locales then English
331 * Fixed potential unwanted URL encoding in the content after Embed Privacy replaced an embed
332
333 = 1.4.0 =
334 * Added support for Pinterest and Wolfram Cloud
335 * Improved migrations to fix duplicate providers or performance problems in multisite installations
336 * Embeds can now be enabled via keyboard
337 * Added a link to the original content on the bottom right overlay corner
338 * Added support for caching the opt-out shortcode
339 * Clicking on the "always enable content of X" enables all embeds of this provider on the current page immediately
340 * Improved markup of local tweets
341 * Added additional class to checkbox paragraph, thanks to @florianbrinkmann
342 * System providers cannot be deleted anymore
343 * Fixed oEmbed provider name if the provider is unknown
344 * Fix enqueuing assets for unknown embed providers
345
346 = 1.3.6 =
347 * Fixed enabling multiple YouTube videos in Elementor
348 * Fixed displaying content if the page contains an always active provider
349
350 = 1.3.5 =
351 * Fixed functionality in Elementor
352 * Fixed custom embed provider output
353 * Fixed replacing content in shortcodes multiple times
354 * Fixed checking for theme/template
355
356 = 1.3.4 =
357 * Fixed deleted meta fields if you put an embed provider in trash and restore it afterwards
358 * Fixed Embed Privacy sometimes trying to replace an embed twice
359 * Fixed an error that may occur if Embed Privacy tries to replace an embed that doesn't need to be replaced
360 * Fixed checking for local domain if WordPress itself is located in a sub-domain
361 * Fixed always enable YouTube within Divi
362 * Fixed overlay line height in Divi
363
364 = 1.3.3 =
365 * Improved mobile design for responsive embeds
366 * Fixed centering for non-responsive embeds
367 * Fixed disabled embed content from preventing interactions with the text below the overlay
368
369 = 1.3.2 =
370 * Fixed general activation error
371
372 = 1.3.1 =
373 * Fixed a fatal error on uninstallation on non-multisite
374 * Fixed activating via WP-CLI
375 * Fixed deleting an option on uninstallation
376
377 = 1.3.0 =
378 * Added local tweets without overlay
379 * Added option to preserve data on uninstall
380 * Added compatibility with theme Astra
381 * Added filter `embed_privacy_markup` for filtering the whole markup of an embed overlay
382 * Added proper support for embeds on the current domain
383 * Added support for embeds on other elements than `embed`, `iframe` and `object`
384 * Enqueue assets only if needed
385 * Removed images from media (which had been added in version 1.2.0) and use fallback images for default embed providers
386 * Improved regular expression for Google Maps
387 * Improved texts for clarity
388 * Fixed visibility of custom post type
389 * Fixed network-wide activation
390 * Fixed clearing oEmbed cache
391
392 = 1.2.2 =
393 * Added a check if a migration is already running
394 * Fixed a bug where the page markup could be changed unexpectedly
395 * `<object>` elements are now replaced correctly
396 * Added a missing textdomain to a string
397 * Excluded local embeds (with the same domain)
398 * Fixed Amazon Kindle regex being too greedy
399
400 = 1.2.1 =
401 * Fixed a bug where the page markup could be changed unexpectedly
402 * Fixed a warning if an embed provider has no regular expressions
403 * Improved migrations of embed provider metadata to make sure they have been added to the database
404
405 = 1.2.0 =
406 * Added support for managing embeds (add/remove/edit/disable)
407 * Added support for caching plugins by adding a JavaScript detection for always active embed providers
408 * Added CSS classes that indicate the current state of the embed (`is-disabled`/`is-enabled`)
409 * Added shortcode `[embed_privacy_opt_out]` to allow users to opt-out/in
410 * Fixed responsive design if the embed added an own width
411
412 = 1.1.3 =
413 * Changed provider name from Polldaddy to Crowdsignal
414 * Removed provider Hulu
415
416 = 1.1.2 =
417 * Fixed a possible difference in the used class name of the embed provider in HTML and CSS
418
419 = 1.1.1 =
420 * Removed provider CollegeHumor
421 * Fixed a bug with the automatic addition of paragraphs
422
423 = 1.1.0 =
424 * Added option to allow all embeds by one provider
425 * Added provider TikTok, introduced in WordPress 5.4
426 * Added support for Google Maps iframes
427 * Added URL rewrite to youtube-nocookie.com
428 * Added option to save user selection per embed provider
429 * Added provider logo to our placeholder
430 * Added option to filter our placeholders markup
431 * Added support for 'alignwide' and 'alignfull' Gutenberg classes
432 * Added support for using our embedding overlay mechanism for external developers
433 * Improved our placeholder markup to be actually semantic
434 * Changed .embed- classes to .embed-privacy-
435 * Fixed some embed providers that use custom z-index, which results in the embedded content being above the overlay
436 * Fixed typos
437
438 = 1.0.2 =
439 * Improved compatibility with [Autoptimize](https://wordpress.org/plugins/autoptimize/)
440 * Improved compatibility with [AMP](https://wordpress.org/plugins/amp/)
441 * Fix issue with SlideShare causing wrong (generic) placeholders
442
443 = 1.0.1 =
444 * Fixed support for PHP 5.6
445
446 = 1.0.0 =
447 * Initial release
448
449 == Upgrade Notice ==
450
451 == Screenshots ==
452 1. Add embeds using the classic editor or the block editor's embed blocks.
453 2. Embed Privacy will add an overlay to supported embeds automatically.
454 3. You can customize the overlays for each service individually.
455 4. Different settings allow you to adjust the functionality of Embed Privacy according to your needs.
456