WordPress: Eigenen oEmbed-Provider registrieren

Wer einen eigenen Provider für oEmbed (siehe codex) registrieren möchte, ist relativ schnell am Ziel. Doch was ist das eigentlich?

oEmbed ist ein offenes Format, welches erlaubt, Daten in eine andere Webseite einzubetten. Dazu braucht man die Struktur der Daten nicht genau kennen. Alles was man braucht, ist ein Link zu einer Ressource. Das Ergebnis ist dabei immer gleich aufgebaut. Einziger Unterschied eventuell das Format – hier wird immer XML und JSON unterstützt.

Beispiele

So sieht ein oEmbed-Request zu Flickr beispielsweise so aus:

Der entsprechende Response sieht so aus:

Wenn man das nun mit einem Ergebnis von Youtube vergleicht, unterscheiden sich die Ergebnisse nicht besonders:

Nur dass hier JSON im Standard geliefert wird.

Bei Twitter sieht es ebenfalls so aus:

Ergebnis:

Weitere Parameter

Zusätzlich können weitere Parameter wie maxwidth und maxheight übergeben werden. So kann dem Provider mitgeteilt werden, wieviel Platz zur Verfügung steht. Der Parameter format beschreibt, in welchem Format man das Ergebnis erwartet. Dazu muss man sagen, dass einige Provider den Parameter format ignorieren und je Format zwei verschiedene Endpunkte zur Verfügung stellen.

Verwendung in WordPress

In WordPress wurde dieser Standard schon komplett implementiert. Die gängigsten Provider sind auch bereits im Standard hinterlegt und funktionieren ohne weitere Konfiguration. Möchte man nun einen eigenen Dienst anbinden, muss man sich an ein paar Events hängen, um den eigenen Provider zu registrieren.

Den besten Einstieg bietet sicherlich die Klasse WP_oEmbed (wp-includes/class-oembed.php). In der Datei stehen folgende Filter zur Verfügung:

  • oembed_providers
  • oembed_result
  • oembed_linktypes
  • oembed_fetch_url
  • oembed_dataparse

Der kompliziertere Part ist sicherlich die Implementierung von oEmbed auf der eigenen Serverseite. Aber auch das ist dank dem relativ einfach gestalteten Standard nicht sehr kompliziert. Das entsprechende WordPress-PlugIn ist dank der vorhanden Klasse schnell geschrieben.

Da nicht jeder Dienst eine oEmbed-Schnittstelle anbietet, holen dies andere Dienste wie noembed oder embed.ly nach.

Tests / Cache

Es ist darauf zu achten, dass WordPress die Ergebnisse der Services speichert. So werden nicht bei jedem Post-Aufruf die Services erneut aufgerufen. Problematisch ist das, wenn man viel ausprobieren möchte. Falls man die gespeicherten Daten löschen möchte, um den Request zu erzwingen, muss man die folgenden Einträge in der DB löschen:

  • Tabelle: wp_postmeta
  • Suche: meta_key LIKE ‚%_oembed%‘

All diese Einträge können bedenkenlos gelöscht werden.

oEmbed-Cache

Über

Jahrgang 87, gelernter Softwareentwickler und fast ein Jahrzehnt Erfahrung im Bereich Web-Entwicklung mit PHP und Web-Design. Diese Eigenschaften machen mich zu einem geeigneten und geschätzten Ansprechpartner für die Umsetzung Ihres Projektes. Weiterhin bin ich seit Ende 2013 Magento Certified Developer.