https://github.com/liquidlight/typo3-shortcodes
Wordpress-style shortcodes for TYPO3
https://github.com/liquidlight/typo3-shortcodes
extension typo3 typo3-cms-extension typo3-extension
Last synced: 6 months ago
JSON representation
Wordpress-style shortcodes for TYPO3
- Host: GitHub
- URL: https://github.com/liquidlight/typo3-shortcodes
- Owner: liquidlight
- Created: 2021-11-15T07:45:37.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-01-14T08:20:02.000Z (6 months ago)
- Last Synced: 2026-01-14T12:12:11.988Z (6 months ago)
- Topics: extension, typo3, typo3-cms-extension, typo3-extension
- Language: PHP
- Homepage: https://extensions.typo3.org/extension/shortcodes
- Size: 127 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Shortcodes
Wordpress style shortcodes for embedding external content in TYPO3.
## Installation
```
composer req liquidlight/typo3-shortcodes
```
## Usage
Out of the box the extension comes with plenty of shortcodes to get you started; including YouTube, Vimeo, Facebook, Twitter and several others.
To use the shortcodes, you can use a shorthand syntax or follow the Wordpress, HTML inspired method.
More details below as to the exact usage for each tag, but as an example, the YouTube one could be used like one of the following:
**⚠️ If using a full URL, it is worth leaving a space between the end of the link and the closing square bracket - this prevents the `]` being used in the link**
### Shorthand colon syntax
```
[youtube: https://www.youtube.com/watch?v=JrFFN9lag2w ]
```
### Shorthand equals syntax
```
[youtube=https://www.youtube.com/watch?v=JrFFN9lag2w ]
```
### Wordpress Long-form syntax
```
[youtube url="https://www.youtube.com/watch?v=JrFFN9lag2w" ]
```
## Creating your own keyword
In the land of shortcodes, keyword is the "service" used to trigger the shortcode (e.g. `youtube` in the examples above).
Registering your own keyword requires a new class which extends `LiquidLight\Shortcodes\Keywords\AbstractKeyword`.
An example of how to extend and use can be found in the Classes/Keywords folder - anything but the `AbstractKeyword` class can be copied and used.
Once created, you can add it via the `ext_localconf.php` where `new` is the name of the keyword.
```php
$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['shortcodes']['processShortcode']['new'] =
\Vendor\Ext\Keywords\NewKeyword::class;
```
Using this method allows you to overwrite existing keywords if you wish to alter their output. The only requirement is that you return a string.
## Existing Shortcodes
All shortcodes allow `title` as an attribute to add a title to `iframe` based shortcodes. If it is not added, it will default to the type (e.g. "Google Maps")
### Facebook
`[facebook]`
Copy the URL of a facebook post or video
```
[facebook=https://www.facebook.com/20531316728/posts/10154009990506729/ ]
```
**Properties:**
- url
- width
- height
**Defaults:**
```
[facebook=LINK width="500"]
```
### Google Maps
`[googlemaps]`
**⚠️ Google Maps [requires an API key setting up](https://developers.google.com/maps/documentation/embed/cloud-setup) - see the setup section below for adding your key**
Shows a place, satellite, directions or streetview of a place.
```
[googlemaps search="Paris" ]
```
**Properties:**
All the properties are of that listed [in the documentation](https://developers.google.com/maps/documentation/embed/embedding-map).
The only differences are:
- `search` can be used instead of `q`
- The addition of `loading` - defaults to `lazy` but can be set to `eager`
#### Setup
To use the `googlemaps` shortcode, an API key must be set.
By default, it will look in your `$_ENV` variables for `GOOGLE_MAP_API`.
However it can be set in `ext_localconf` however you see fit (please don't commit your API key).
```php
$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['shortcodes']['config']['api']['googlemaps'] = '123';
```
**If you restrict the API key type**, ensure you have the following enabled
- Maps Embed API
- Maps JavaScript API
- Maps Static API
### Iframe
`[iframe]`
Allows a generic iframe to be rendered with the passed in URL
```
[iframe: https://typo3.com/ ]
```
**Properties:**
- src
- width
- height
- ratio - iframe ratio in a colon or slash format (e.g. `ratio="4:3"` or ``ratio="16/9"``) - rendered as a `data-ratio` attribute
- allowfullscreen
- allow
- frameBorder
### Instagram
`[instagram]`
Embeds an Instagram post
```
[instagram=https://www.instagram.com/p/CWI-FeDs-us/ ]
```
### LinkedIn
`[linkedin]`
Embeds an Linked post - ensure the url has `urn:li:activity` or similar in it.
For example:
```
[linkedin=https://www.linkedin.com/feed/update/urn:li:activity:6856570271759949825/ ]
```
**Properties:**
- height
- width
- loading - defaults to `lazy` but can be set to `eager`
**Defaults:**
```
[linkedin=LINK width="100%" height="600"]
```
### Soundcloud
`[soundcloud]`
Shows a Soundcloud player for a track or artists - can have the size & colour customised. Use the URL
For example:
```
[soundcloud=https://soundcloud.com/cbschmidt/seodriven-331 ]
```
**Properties:**
- url
- maxwidth
- maxheight - can be 166 or 450
- color
- auto_play
- show_comments
### Spotify
`[spotify]`
Go to Spotify and click on what you want to embed - song, artist, playlist etc.
Click the 3 dots -> Share -> Copy Link
```
[spotify=https://open.spotify.com/track/3gdewACMIVMEWVbyb8O9sY?si=145df8aede6a4b04 ]
```
**Properties:**
- height - can be 80 or 380
- theme - can be 1 or 0 (disables the coloured background)
- loading - defaults to `lazy` but can be set to `eager`
**Defaults:**
```
[spotify=LINK height="380" theme="1"]
```
### X
`[x | twitter | tweet]`
Copy the URL (or the status code) of a tweet
```
[x=https://twitter.com/Interior/status/463440424141459456 ]
```
**Properties:**
Any properties are passed through to the [oembed-api](https://developer.twitter.com/en/docs/twitter-for-websites/timelines/guides/oembed-api), so the list & defaults can be found there
```
[tweet=https://twitter.com/Interior/status/463440424141459456 theme="light"]
```
### Video
`[video]`
The video element outputs an `` with the src of that passed in. It allows an arbitrary URL to a video to be passed in and it will wrap it in a `
` for responsive styling purposes.
```
[video=https://www.liquidlight.co.uk/path/to/video ]
```
**Properties**
- code - optional if using the shorthand syntax
- url - optional if using the shorthand syntax
- width
- height
- ratio - video ratio in a colon format (e.g. `ratio="4:3"`) - defaults to `16:9` - rendered as a `data-ratio` attribute for styling
- loading - defaults to `lazy` but can be set to `eager`
### Vimeo
`[vimeo]`
Renders a Vimeo iframe embed. Can take a full URL or code.
```
[vimeo=]
```
See [Video](#video) for properties and use.
### YouTube
`[youtube]`
Renders a YouTube iframe embed. Can take a full URL or code.
```
[youtube=https://www.youtube.com/watch?v=JrFFN9lag2w ]
```
See [Video](#video) for properties and use.
## Semantic HTML
To ensure your HTML remains semantic, shortcode elements will break out of typographic elements and remove any empty sibling elements.
For example, if your editor had entered the following in the RTE:
```html
You can watch our latest video [youtube code=123] here
```
You will find the following HTML output
```html
You can watch our latest video
here
```
If, once the shortcode is placed after it's original element, the original element would be empty, it gets removed from the HTML.
Elements which the shortcode will break out from:
- pre
- h1
- h2
- h3
- h4
- h5
- h6
- p
The extension will also ensure inline elements (such as `span`, `a` etc.) are closed appropriately.