gnu-social/plugins/Embed
2021-02-21 20:20:48 +00:00
..
actions [Media] Fix issues with database file storage 2021-02-21 16:03:46 +00:00
classes [Embed] Refactoring and bug fixing 2019-08-03 17:49:09 +01:00
lib [Embed] Removed old oEmbed and OpenGraph implementation 2019-08-03 17:49:09 +01:00
locale [VersionBump] 2.0.0alpha0 2020-08-04 05:31:44 +01:00
scripts [DATABASE] Fix use of ORDER BY with DISTINCT 2020-08-27 11:15:39 +03:00
tests [CORE] Add GNUSOCIAL_ENGINE_REPO_URL and increase usage of GNUSOCIAL_ENGINE_URL 2019-11-21 00:21:22 +00:00
CONFIGURE [OEmbed][Embed] Renamed OEmbed plugin to Embed 2019-08-03 17:48:26 +01:00
EmbedPlugin.php [Embed] Revert defaults and fix Readme example 2021-02-21 20:20:48 +00:00
README.md [Embed] Revert defaults and fix Readme example 2021-02-21 20:20:48 +00:00

The Embed plugin for using and representing both Open Graph and oEmbed data.

See: https://ogp.me/ and https://www.oembed.com/

Installation

This plugin is enabled by default.

Settings

  • domain_whitelist: Array of regular expressions. Always escape your dots and end your strings.
  • check_whitelist: Whether to check the domain_whitelist.
  • thumbnail_width: Maximum width of the thumbnail in pixels. Defaults to 128. Setting as null makes it use global [thumbnail][width].
  • thumbnail_height: Maximum height of the thumbnail in pixels. Defaults to 128. Setting as null makes it use global [thumbnail][height].
  • crop: Crop to the size (not preserving aspect ratio). Defaults to true. Setting as null makes it use global [thumbnail][crop].
  • max_size: Max media size. Anything bigger than this is rejected. Defaults to global [attachments][file_quota].

Relevant GNU social global settings

  • [attachments][show_html]: Whether to show HTML oEmbed data. Defaults to false.

Example

$config['attachments']['show_html'] = true;
addPlugin('Embed', [
    'thumbnail_width' => 42,
    'thumbnail_height' => 42,
    'domain_whitelist' => [
        '^i\d*\.ytimg\.com$' => 'YouTube',
        '^i\d*\.vimeocdn\.com$' => 'Vimeo'
    ],
    'check_whitelist' => true
    ]
);