coldtrick/oembed

Provides oEmbed support for URLs in text

Fund package maintenance!
ColdTrick
www.paypal.me/ColdTrick

Installs: 2 469

Dependents: 0

Suggesters: 0

Security: 0

Stars: 3

Watchers: 4

Forks: 2

Open Issues: 0

Type:elgg-plugin

v5.0.2 2024-06-28 06:59 UTC

This package is auto-updated.

Last update: 2024-10-28 07:39:13 UTC


README

Elgg 5.0 Elgg 6.0 Lint Checks Latest Stable Version License

Provides oEmbed support for URLs in text

Features

  • This plugin tries to replace URLs in output/longtext with embed code. For example if you paste a YouTube URL it will be replaced by the embed code for that URL.
  • Nothing is done to the original text, so if the plugin is disabled all original links are still present.
  • In order to control which URLs should be replaced there is a plugin setting for a whitelist and a blacklist. If the whitelist is set only those URLs will be replaced and the blacklist is ignored. If only the blacklist is set, every URL except those on the blacklist will be replaced.

Caching

The results of the oEmbed requests is cached in system cache. This is to increase performance and reusability. If the cache is flushed requests will be made again.

Developers

Prevent oEmbed

In order to prevent the use of oEmbed on your use of output/longtext set a var 'oembed' => false.

Modifying valid URL

Before an oEmbed adapter is created based on a valid URL an event is triggered. This allows last minute changes to the URL (eg. adding validation tokens). The event is replace_url, oembed. The return value should be a URL. in the $params you get the original url under url.

Output views

To change the output of the oEmbed code the different types have their own view oembed/type/{$oembed_type}.