Shortcode

Ein Shortcode ist ein Kurzbefehl in eckigen Klammern (z. B. [kontaktformular]), der in WordPress-Beiträgen und -Seiten als Platzhalter für dynamische Inhalte dient. Beim Laden der Seite ersetzt WordPress den Shortcode durch den zugehörigen Ausgabecode – das kann ein Formular, eine Galerie, ein Video-Player oder jede andere beliebige Funktion sein. Shortcodes wurden mit WordPress 2.5 eingeführt und waren lange Zeit die wichtigste Methode, um komplexere Elemente in Inhalte einzubinden.

Technischer Hintergrund

Shortcodes werden in PHP über die Funktion add_shortcode() registriert, typischerweise in einem Plugin oder in der functions.php eines Themes. Die Funktion verknüpft einen Shortcode-Namen mit einer Callback-Funktion, die den HTML-Output zurückgibt. Shortcodes können Parameter akzeptieren (z. B. [galerie spalten="3" sortierung="datum"]) und verschachtelt werden.

Es gibt drei Arten von Shortcodes: Selbstschließende Shortcodes wie [kontaktformular], umschließende Shortcodes wie [hervorhebung]Text[/hervorhebung], die Inhalt zwischen öffnendem und schließendem Tag verarbeiten, und Shortcodes mit Parametern. WordPress verarbeitet alle Shortcodes über eine zentrale Parser-Funktion (do_shortcode()), bevor der Seiteninhalt ausgegeben wird.

Mit der Einführung des Block-Editors verlieren Shortcodes zunehmend an Bedeutung, da viele ihrer Funktionen durch Blöcke abgebildet werden können. Der Block-Editor bietet zwar weiterhin einen „Shortcode“-Block für die Rückwärtskompatibilität, neue Funktionen werden jedoch bevorzugt als eigenständige Blöcke entwickelt.

Bedeutung für die WordPress-Wartung

Shortcodes erzeugen eine direkte Abhängigkeit zwischen dem Inhalt und dem Plugin oder Theme, das sie bereitstellt. Wird das Plugin deaktiviert oder gelöscht, verbleiben die Shortcodes als sichtbarer Klartext im Inhalt – Besucher sehen dann z. B. den Text [kontaktformular] anstelle des eigentlichen Formulars. Das macht die Pflege von Shortcode-lastigen Websites aufwendig.

Bei der Wartung sollte dokumentiert werden, welche Shortcodes verwendet werden und welches Plugin sie bereitstellt, um Abhängigkeiten transparent zu machen und einen versehentlichen Funktionsverlust zu vermeiden.

Häufige Probleme

• Sichtbarer Shortcode-Text auf der Website, wenn das zugehörige Plugin deaktiviert oder entfernt wurde.
• Verschachtelte Shortcodes, die nicht korrekt aufgelöst werden, weil die Reihenfolge der Verarbeitung nicht stimmt.
• Performance-Probleme bei Seiten mit vielen Shortcodes, da jeder einzelne zur Ladezeit verarbeitet wird.
• Schwierige Migration: Beim Wechsel eines Plugins müssen alle Shortcodes in den Inhalten manuell angepasst werden.
• Shortcodes funktionieren nicht in allen Kontexten (z. B. in Widgets oder Menü-Beschreibungen) ohne zusätzliche Konfiguration.

Best Practices

• Für neue Projekte bevorzugt Blöcke im Block-Editor statt Shortcodes verwenden.
• Bestehende Shortcodes dokumentieren: Welcher Shortcode wird wo verwendet und welches Plugin stellt ihn bereit?
• Vor dem Deaktivieren eines Plugins prüfen, ob es Shortcodes bereitstellt, die in Inhalten verwendet werden.
• Bei einer Migration von Shortcodes zu Blöcken schrittweise vorgehen und jede Seite einzeln prüfen.
• Shortcodes möglichst sparsam einsetzen und auf wenige, gut gepflegte Plugins beschränken, um Abhängigkeiten überschaubar zu halten.