Shortcodes für Entwickler

Dieses Dokument listet jeden vom ADP Car Market Hub-Plugin registrierten Shortcode auf, einschließlich der unterstützten Attribute, der gerenderten Ausgabe und der Feature-Toggles, die die Verfügbarkeit beeinflussen. Verwenden Sie es als Referenz, wenn Sie Plugin-Inhalte in Seiten, Beiträge oder benutzerdefinierte Block-Layouts einbetten.

Wann Sie dieses Dokument verwenden sollten

Lesen Sie dieses Dokument, wenn Sie Folgendes tun müssen:

• Das Fahrzeugarchiv, die Vergleichsseite, den Suchfilter, die Favoritenliste oder Standort-/Öffnungszeiten-Blöcke in eine reguläre WordPress-Seite einbetten.
• Eine benutzerdefinierte Landingpage erstellen, die einen dieser Shortcodes mit vorausgefüllten Attributen verwendet.
• Überprüfen, welches Feature-Toggle welchen Shortcode deaktiviert.

Informationen zu den Templates, die diese Shortcodes laden, finden Sie unter Template-System und Overrides. Die abgefragten Inhaltstypen finden Sie unter Custom Post Types und Taxonomien.

Übersicht

Das Plugin registriert sechs Shortcodes. Drei rendern den öffentlichen Katalog (Archiv, Suchfilter, Vergleichsseite); einer rendert die kundenseitige Favoritenliste/Wunschliste; und zwei rendern Standortinformationen des Verkäufers für das aktuelle Fahrzeug.

Die Shortcodes selbst stellen die unterstützte, stabile öffentliche Schnittstelle dar. Die internen Klassen, die sie registrieren, und der für die Registrierung verwendete WordPress-Hook sind Implementierungsdetails und werden hier nicht dokumentiert.

Anforderungen oder Voraussetzungen

• Das Plugin muss aktiv sein.
• Mindestens ein veröffentlichter Fahrzeugdatensatz, damit die Katalog- und Vergleichs-Shortcodes eine sinnvolle Ausgabe erzeugen.
• Das entsprechende Feature-Toggle muss in der Admin-Benutzeroberfläche des Plugins aktiviert sein (siehe Tabelle unten).
• Für den Vergleichs-Shortcode muss eine Vergleichsseite (die [as24ci_compare] enthält) existieren. Das Plugin erstellt eine solche bei der Aktivierung.
• Für den Favoriten-Shortcode muss das Toggle für die öffentliche REST API in der Admin-Benutzeroberfläche des Plugins aktiviert sein, damit der Favoriten-Endpunkt erreichbar ist.

Shortcode-Referenz

[as24ci_archive]

Rendert dieselbe Fahrzeugliste wie das öffentliche Archiv (/cars/), einschließlich Filtern, Sortierung und Paginierung. Verwenden Sie diesen Shortcode, um den Katalog in eine beliebige reguläre WordPress-Seite oder ein Block-Layout einzubetten.

Attribute

GET-Parameter, die vom Besucher übergeben werden (Filter, Sortierung, Paginierung), überschreiben die Shortcode-Attribute, sodass sich die eingebettete Liste weiterhin wie ein voll interaktives Archiv verhält.

Feature-Gate: Keines (der Shortcode ist immer registriert).

[as24ci_compare]

Rendert die Fahrzeug-Vergleichsseite. Fahrzeuge werden von Besuchern über Vergleichs-Buttons im Katalog ausgewählt und clientseitig gespeichert; dieser Shortcode zeigt die Vergleichstabelle für die aktuelle Auswahl an.

Attribute: Keine.

Feature-Gate: Erfordert, dass die Vergleichsfunktion in der Admin-Benutzeroberfläche des Plugins aktiviert ist.

[as24ci_search_filter]

Rendert das Suchfilter-Formular einzeln (ohne die Ergebnisliste). Verwenden Sie es, um eine dedizierte Such-Landingpage zu erstellen, die Ergebnisse an eine separate Seite sendet (beispielsweise eine Seite, die [as24ci_archive] enthält).

Attribute

Feature-Gate: Keines.

[as24ci_favorites]

Rendert die kundenseitige Favoriten-/Wunschliste. Favoriten werden clientseitig gespeichert und über den REST-Endpunkt des Plugins synchronisiert, wenn die REST API aktiviert ist.

Attribute: Keine.

Feature-Gate: Erfordert, dass die Favoritenfunktion und die öffentliche REST API in der Admin-Benutzeroberfläche des Plugins aktiviert sind.

[as24ci_location_box]

Rendert eine Box mit Standort-/Kontaktinformationen für ein Fahrzeug. Innerhalb eines einzelnen Fahrzeug-Templates verwendet die Box den Verkäufer des aktuellen Fahrzeugs; auf anderen Seiten muss eine post_id angegeben werden.

Attribute

Feature-Gate: Keines, aber die angezeigten Informationen hängen von den im Admin-Bereich konfigurierten Standorten und Händlerprofil-Daten ab.

[as24ci_hours_box]

Rendert die Box mit den Öffnungszeiten für den mit einem Fahrzeug verknüpften Standort. Es gilt dieselbe Auswahlregel wie bei [as24ci_location_box].

Attribute

Feature-Gate: Keines. Die Ausgabe hängt von den konfigurierten Standorten ab.

Schritt-für-Schritt-Anleitung

Eine dedizierte Such-Landingpage erstellen

1. Erstellen Sie eine neue WordPress-Seite, die die Ergebnisse anzeigen soll – zum Beispiel eine Seite namens „Fahrzeuge durchsuchen“, die [as24ci_archive] enthält.
2. Erstellen Sie eine weitere Seite, die das Suchformular enthalten soll – zum Beispiel „Fahrzeug finden“.
3. Fügen Sie [as24ci_search_filter results_url="/browse-cars/"] zur Suchseite hinzu.
4. Veröffentlichen Sie beide Seiten und verlinken Sie im Menü auf „Fahrzeug finden“.

Eine kuratierte Fahrzeugliste einbetten

1. Fügen Sie auf der Seite, auf der Sie die Liste anzeigen möchten, [as24ci_archive make="BMW" body="SUV" order_by="price" order="asc" per_page="12"] hinzu.
2. Veröffentlichen Sie die Seite. Besucher können die Liste weiterhin über die angezeigten Filter verfeinern; ihre Auswahl überschreibt die Standardeinstellungen des Shortcodes.

Die Favoritenseite anzeigen

1. Erstellen Sie eine Seite „Meine Favoriten“.
2. Fügen Sie [as24ci_favorites] hinzu und veröffentlichen Sie die Seite.
3. Stellen Sie sicher, dass sowohl die Favoriten- als auch die REST-Funktionen in den Plugin-Einstellungen aktiviert sind.

Betriebshinweise

• Asset-Enqueueing. Wenn ein Shortcode auf einer Seite erkannt wird, lädt der Asset-Loader des Plugins automatisch die passenden Frontend-Assets.
• Feature-Toggles. Das Deaktivieren der entsprechenden Funktion in der Admin-Benutzeroberfläche verhindert das Erscheinen der Shortcode-UI oder unterdrückt im Fall von [as24ci_compare] die Vergleichs-Skripte, obwohl der Shortcode selbst registriert bleibt.
• Render-Kontext. [as24ci_location_box] und [as24ci_hours_box] sind auf einen Fahrzeug-Kontext angewiesen. Wenn sie außerhalb eines Einzel-Fahrzeug-Templates aufgerufen werden, übergeben Sie immer post_id.
• Layout-Manager. Das Fahrzeugarchiv und das Einzel-Fahrzeug-Layout werden auch vom Layout-Manager des Plugins beeinflusst, der in der Admin-Benutzeroberfläche konfiguriert wird. Das Einbetten von [as24ci_archive] verwendet dieselbe Layout-Konfiguration.
• Caching. Wenn Sie einen Full-Page-Cache verwenden, stellen Sie sicher, dass dieser nicht das dynamische Markup oder die Inline-Datenattribute entfernt, die von den Favoriten- und Vergleichs-Skripten verwendet werden.
• Anpassung. Ziehen Sie das Überschreiben von Theme-überschreibbaren Templates (siehe Template-System und Overrides) dem Forken der zugrundeliegenden Plugin-Templates vor.

Fehlerbehebung

• Leere Liste bei Verwendung von [as24ci_archive]. Stellen Sie sicher, dass veröffentlichte Fahrzeuge vorhanden sind und dass einschränkende Attribute (make, model, price_min, price_max, fuel, body) die Ergebnisse nicht zu stark filtern. GET-Parameter von Besuchern überschreiben Shortcode-Standardwerte – testen Sie die Seite in einem privaten Fenster mit einer sauberen URL.
• [as24ci_compare] zeigt nichts an. Stellen Sie sicher, dass die Vergleichsfunktion im Admin-Bereich aktiviert ist und dass der Besucher tatsächlich Fahrzeuge zum Vergleichen ausgewählt hat. Die Auswahl erfolgt clientseitig, sodass verschiedene Browser unterschiedliche Listen sehen.
• [as24ci_search_filter] leitet nicht auf die richtige Seite weiter. Stellen Sie sicher, dass das Attribut results_url auf eine gültige URL Ihrer Website eingestellt ist. Falls es fehlt, sendet das Formular die Daten an die aktuelle Seite und zeigt möglicherweise keine Ergebnisse an, es sei denn, die Seite enthält auch [as24ci_archive].
• [as24ci_favorites] funktioniert lokal, aber nicht auf Staging. Stellen Sie sicher, dass die öffentliche REST API in der Admin-Benutzeroberfläche des Plugins aktiviert und erreichbar ist und dass kein Sicherheits-Plugin den REST-Namespace des Plugins blockiert.
• Standort- oder Öffnungszeiten-Box ist leer. Überprüfen Sie, ob für den Verkäufer des Fahrzeugs Standortdaten und Händlerprofil-Felder konfiguriert sind.
• Überprüfen Sie das Verhalten in der aktuellen Plugin-Version, bevor Sie eine benutzerdefinierte Integration veröffentlichen. Shortcode-Attribute und gerendertes Markup können sich zwischen den Versionen ändern.

Verwandte Dokumente

• Template-System und Overrides
• Custom Post Types und Taxonomien
• Frontend Assets
• REST API für Entwickler
• AJAX-Aktionen für Entwickler
• Option-Keys und Speicherung von Einstellungen