PHPackages                             betterembed/neos-betterembed - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. betterembed/neos-betterembed

ActiveNeos-plugin[Utility & Helpers](/categories/utility)

betterembed/neos-betterembed
============================

BetterEmbed integration for Neos CMS

2.0.1(3y ago)107.1k↑14.6%8[2 issues](https://github.com/betterembed/neos-betterembed/issues)[1 PRs](https://github.com/betterembed/neos-betterembed/pulls)GPL-3.0-or-laterPHP

Since Jun 7Pushed 2y ago4 watchersCompare

[ Source](https://github.com/betterembed/neos-betterembed)[ Packagist](https://packagist.org/packages/betterembed/neos-betterembed)[ Docs](https://github.com/betterembed/neos-betterembed)[ RSS](/packages/betterembed-neos-betterembed/feed)WikiDiscussions master Synced today

READMEChangelog (9)Dependencies (2)Versions (13)Used By (0)

[![Latest stable version](https://camo.githubusercontent.com/e0baeb052222fa3d491bcef9aecc9eb09fd60d1fc8a17539c108b8914144f060/68747470733a2f2f706f7365722e707567782e6f72672f626574746572656d6265642f6e656f732d626574746572656d6265642f762f737461626c65)](https://packagist.org/packages/betterembed/neos-betterembed) [![Total downloads](https://camo.githubusercontent.com/ebea9aa5984c8cb25b84444f4d5aa8e313686e30e9506cf4c4b19e0428e8e061/68747470733a2f2f706f7365722e707567782e6f72672f626574746572656d6265642f6e656f732d626574746572656d6265642f646f776e6c6f616473)](https://packagist.org/packages/betterembed/neos-betterembed) [![License](https://camo.githubusercontent.com/a591dbf731f1d60903a0f852ee52b4cd184a5df715922b46817de9e1ac3ffb72/68747470733a2f2f706f7365722e707567782e6f72672f626574746572656d6265642f6e656f732d626574746572656d6265642f6c6963656e7365)](https://packagist.org/packages/betterembed/neos-betterembed)

BetterEmbed integration for Neos CMS
====================================

[](#betterembed-integration-for-neos-cms)

BetterEmbed is a free service to easily integrate content like Twitter posts, blog posts, or any other kind of remote content.

**Notice**: Due GDPR consent access gateways, not every URL will work. For instance there are known issues with Facebook, and Instagram.

Benefits of BetterEmbed
-----------------------

[](#benefits-of-betterembed)

- easily integrate external content
- improve privacy by keeping out unwanted tracking cookies (GDPR)
- increase page speed by not loading external Javascript and CSS resources

If you want to know more, please visit  to see the full feature list and get more information about the project.

Installation
------------

[](#installation)

Add the dependency to your site package like this:

```
composer require --no-update betterembed/neos-betterembed
```

And then run `composer update` in your project's root folder.

Dependencies
------------

[](#dependencies)

This package currently only requires Neos >= `8` and `guzzlehttp/guzzle`

Usage
-----

[](#usage)

[![BetterEmbed content element](Documentation/BetterEmbed-Content-Element.png)](Documentation/BetterEmbed-Content-Element.png)

[![BetterEmbed Placeholder](Documentation/BetterEmbed-Placeholder.png)](Documentation/BetterEmbed-Placeholder.png)

### Examples

[](#examples)

#### Website Example

[](#website-example)

[![BetterEmbed example blog post](Documentation/BetterEmbed-Example-BlogPost.png)](Documentation/BetterEmbed-Example-BlogPost.png)

##### API result

[](#api-result)

```
{
    "url": "https://www.theverge.com/2020/3/23/21175407/remote-work-working-from-home-guide-how-to-tips-video-conference-calls-laptops-zoom-slack",
    "itemType": "The Verge",
    "title": "The Verge Guide to Working at Home",
    "body": "Tips and tricks on being a remote worker",
    "thumbnailUrl": "https://cdn.vox-cdn.com/thumbor/NdRt13PSWplEE-lZkxFEPyc4a8U=/0x146:2040x1214/fit-in/1200x630/cdn.vox-cdn.com/uploads/chorus_asset/file/19822359/acastro_200319_3941_wfhGuide_0003.jpg",
    "authorName": "Barbara Krasnoff",
    "publishedAt": "2020-03-23T08:00:00-04:00"
}
```

#### YouTube Example

[](#youtube-example)

[![BetterEmbed example Youtube 1](Documentation/BetterEmbed-Example-Youtube-1.png)](Documentation/BetterEmbed-Example-Youtube-1.png)[![BetterEmbed example Youtube 2](Documentation/BetterEmbed-Example-Youtube-2.png)](Documentation/BetterEmbed-Example-Youtube-2.png)[![BetterEmbed example Youtube 3](Documentation/BetterEmbed-Example-Youtube-3.png)](Documentation/BetterEmbed-Example-Youtube-3.png)

##### API result

[](#api-result-1)

```
{
    "embedHtml": "",
    "url": "https://www.youtube.com/watch?v=-ZHY85m63k0",
    "itemType": "YouTube",
    "title": "Neos Con 2019 Teaser Trailer | Neos Conference",
    "body": "Only a few weeks and tickets left till the Neos Con 2019 in Dresden from 10th to 11th May. Be sure to save your spot: https://www.eventbrite.de/e/neos-confer...",
    "thumbnailUrl": "https://i.ytimg.com/vi/-ZHY85m63k0/hqdefault.jpg",
    "authorName": "Neos CMS",
    "authorUrl": "https://www.youtube.com/channel/UCQndryIh2s9i3htDrpb6tiw",
    "publishedAt": "2019-03-29T00:00:00+00:00"
}
```

#### Twitter Example

[](#twitter-example)

[![BetterEmbed example Twitter 1](Documentation/BetterEmbed-Example-Twitter-1.png)](Documentation/BetterEmbed-Example-Twitter-1.png)[![BetterEmbed example Twitter 2](Documentation/BetterEmbed-Example-Twitter-2.png)](Documentation/BetterEmbed-Example-Twitter-2.png)[![BetterEmbed example Twitter 3](Documentation/BetterEmbed-Example-Twitter-3.png)](Documentation/BetterEmbed-Example-Twitter-3.png)

```
{
    "embedHtml": "What a blast! ☺️ Two days full of exciting talks, conversations, networking and way more! Thank you all for being part of it! We hope to see you all again soon! 🥰 #neoscon #neos #community pic.twitter.com/nSaZCU2bba— The Neos Project (@neoscms) May 12, 2019\n",
    "url": "https://twitter.com/neoscms/status/1127605365019947008",
    "itemType": "Twitter",
    "title": "The Neos Project on Twitter",
    "body": "“What a blast! ☺️ Two days full of exciting talks, conversations, networking and way more! Thank you all for being part of it! We hope to see you all again soon! 🥰 #neoscon #neos #community”",
    "thumbnailUrl": "https://pbs.twimg.com/media/D6YN2puXkAE_QLr.jpg:large",
    "authorName": "The Neos Project",
    "authorUrl": "https://twitter.com/neoscms",
    "publishedAt": "2019-05-12T16:04:03+00:00"
}
```

Rendering
---------

[](#rendering)

The package includes a default rendering component together with the according Javascript and CSS sources.

### Use your own renderer

[](#use-your-own-renderer)

You can easily register your own rendering component via extending `BetterEmbed.NeosEmbed:Component.Renderer`:

```
prototype(BetterEmbed.NeosEmbed:Component.Renderer)