Dokumentation · Frontend-Handbuch
Shortcodes-Referenz
Dieses Dokument ist eine vollständige Referenz für alle WordPress Shortcodes, die vom ADP Car Market Hub WordPress Plugin bereitgestellt werden.
Wann Sie dieses Dokument verwenden sollten
Verwenden Sie dieses Dokument, wenn Sie Plugin-Ausgaben auf einer WordPress Seite einbetten möchten und die genaue Shortcode-Syntax, die unterstützten Attribute sowie das erwartete Verhalten für jeden Shortcode wissen möchten.
Übersicht
Das Plugin registriert die folgenden Shortcodes:
| Shortcode | Beschreibung |
|---|---|
[as24ci_archive] | Rendert das vollständige Fahrzeugarchiv mit Filtern, Sortierung und Seitennummerierung |
[as24ci_search_filter] | Rendert nur das Suchfilter-Formular, ohne Ergebnisse |
[as24ci_compare] | Rendert die Fahrzeugvergleichstabelle |
[as24ci_favorites] | Rendert die Liste der gespeicherten Favoriten des Besuchers |
[as24ci_location_box] | Rendert die Adressbox des Garagen-Standorts für ein Fahrzeug |
[as24ci_hours_box] | Rendert die Öffnungszeitenbox der Garage für ein Fahrzeug |
[as24ci_archive]
Rendert das vollständige Fahrzeugarchiv einschliesslich Suchfilter-Formular, Ergebnis-Grid oder -Liste, Zustand-Tabs, Sortiersteuerungen, Ergebnissen pro Seite und Seitennummerierung. Erzeugt dieselbe Ausgabe wie die native Custom Post Type Archiv-URL.
Attribute
Alle Attribute sind optional. Wenn ein GET-Parameter mit demselben Namen in der URL vorhanden ist, überschreibt dieser das Shortcode-Attribut.
| Attribut | Typ | Beschreibung | Beispiel |
|---|---|---|---|
make | string | Vorfiltern nach Fahrzeugmarken-Slug | bmw |
model | string | Vorfiltern nach Fahrzeugmodell-Slug | 3-series |
price_min | int | Mindestpreis-Vorfilter | 5000 |
price_max | int | Maximalpreis-Vorfilter | 30000 |
fuel | string | Vorfiltern nach Kraftstofftyp-Slug | diesel |
body | string | Vorfiltern nach Karosserietyp-Slug | suv |
order_by | string | Sortierfeld: price, mileage oder date | price |
order | string | Sortierrichtung: asc oder desc. Verwendet mit order_by. | asc |
per_page | string | Ergebnisse pro Seite: 12, 24, 48, 72 oder all | 24 |
Beispiele
Alle Fahrzeuge rendern:
[as24ci_archive]
Nur Diesel-SUVs aufsteigend nach Preis sortiert rendern:
[as24ci_archive fuel="diesel" body="suv" order_by="price" order="asc"]
Fahrzeuge in einer Preisspanne mit 12 Ergebnissen pro Seite rendern:
[as24ci_archive price_min="10000" price_max="50000" per_page="12"]
Hinweise
- Besucher können nach dem Laden der Seite mit dem Filterformular interagieren. Jede Filterauswahl durch den Besucher überschreibt die Vorfilter-Attribute des Shortcodes via GET-Parameter.
- Die Seitennummerierung verwendet den GET-Parameter
pagedoderpage. - Der Shortcode verwendet die eigene URL der Seite als Action für das Filterformular. Stellen Sie sicher, dass die Seite eine saubere, zugängliche URL hat.
[as24ci_search_filter]
Rendert nur das Suchfilter-Formular, ohne Fahrzeugergebnisse. Verwenden Sie dies auf einer Startseite oder Landingpage, damit Besucher ihre Kriterien festlegen können, bevor sie zur Ergebnisseite weitergeleitet werden.
Attribute
| Attribut | Typ | Beschreibung | Beispiel |
|---|---|---|---|
results_url | string | URL der Ergebnisseite, an die das Formular gesendet wird. Standardmässig die CPT-Archiv-URL oder /cars/. | /inventory/ |
Beispiele
Filterformular, das zum Standard-CPT-Archiv weiterleitet:
[as24ci_search_filter]
Filterformular, das zu einer benutzerdefinierten Ergebnisseite weiterleitet:
[as24ci_search_filter results_url="/car-inventory/"]
Hinweise
- Das Filterformular wird mit denselben Feldern und der gleichen Layout Manager-Konfiguration gerendert wie der Filter der Archivseite.
- Alle GET-Parameter, die bereits auf der aktuellen Seite vorhanden sind, spiegeln sich in den vorausgewählten Werten des Filterformulars wider.
- Wenn einfache (nicht-schöne) Permalinks verwendet werden, ist die CPT-Archiv-URL möglicherweise nicht erreichbar. Setzen Sie in diesem Fall
results_urlexplizit auf eine Seite mit dem Shortcode[as24ci_archive].
[as24ci_compare]
Rendert die Fahrzeugvergleichstabelle. Lädt die Fahrzeug-IDs aus dem GET-Parameter ids (eine kommagetrennte Liste von Post-IDs) und zeigt jedes Fahrzeug als Spalte in einer nebeneinander liegenden Tabelle an.
Attribute
Dieser Shortcode hat keine konfigurierbaren Attribute. Fahrzeug-IDs werden über die URL übergeben.
URL-Format
/compare-page/?ids=123,456,789
Das Vergleichs-JavaScript erstellt diese URL automatisch, wenn der Besucher auf die Schaltfläche "Vergleichen" klickt.
Beispiel
[as24ci_compare]
Platzieren Sie diesen Shortcode auf einer speziellen Seite "Fahrzeuge vergleichen". In den Plugin-Einstellungen sollte die ID dieser Seite als Vergleichsseite hinterlegt sein.
Hinweise
- Die Vergleichstabelle rendert nur veröffentlichte Fahrzeuge des Custom Post Types des Plugins.
- Es werden maximal 4 Fahrzeuge gerendert, unabhängig davon, wie viele IDs übergeben werden. IDs über die ersten 4 hinaus werden stillschweigend ignoriert.
- Wenn kein Parameter
idsvorhanden ist oder alle angegebenen IDs ungültig sind, zeigt die Seite "Keine Fahrzeuge zum Vergleich ausgewählt." - Die in jeder Spalte angezeigten Felder werden im Layout Manager → Bereich "Vergleichen" konfiguriert.
[as24ci_favorites]
Rendert die Liste der gespeicherten Favoriten des Besuchers. Die Liste wird dynamisch per JavaScript mit Fahrzeug-IDs gefüllt, die im localStorage des Browsers gespeichert sind. Das Plugin ruft einen internen REST-Endpunkt auf, um die aktuellen Fahrzeugdaten für jede gespeicherte ID abzurufen.
Attribute
Dieser Shortcode hat keine konfigurierbaren Attribute.
Beispiel
[as24ci_favorites]
Platzieren Sie diesen Shortcode auf einer speziellen Seite "Meine Favoriten".
Hinweise
- Die Seite benötigt JavaScript, um zu funktionieren. Ohne JavaScript kann die Liste nicht befüllt werden.
- Wenn im Browser des Besuchers keine Fahrzeuge gespeichert sind, zeigt die Seite "Sie haben noch keine gespeicherten Favoriten."
- Die REST-API muss öffentlich zugänglich sein. Sicherheits-Plugins, die öffentliche REST-Endpunkte blockieren, verhindern das Laden der Favoritenliste.
- Die auf jeder Favoritenkarte angezeigten Felder werden im Layout Manager → Bereich "Favoriten" konfiguriert.
- Pro Anfrage werden bis zu 50 gespeicherte Fahrzeug-IDs abgerufen.
[as24ci_location_box]
Rendert die Adressbox des Garagen-Standorts für ein Fahrzeug. Die Box zeigt den Namen der Garage, die Telefonnummer, die Adresse und optional eine Schaltfläche "Standort besuchen", wenn eine Website-URL konfiguriert ist.
Der Standort wird ermittelt, indem die AutoScout24 Seller ID des Fahrzeugs mit den konfigurierten Standorten des Plugins abgeglichen wird.
Attribute
| Attribut | Typ | Beschreibung | Beispiel |
|---|---|---|---|
post_id | int | WordPress Post-ID des Fahrzeugs. Standardmässig der aktuelle Post im Loop. | 456 |
Beispiele
Standortbox für ein bestimmtes Fahrzeug:
[as24ci_location_box post_id="456"]
Standortbox für den aktuellen Post (bei Verwendung innerhalb eines Fahrzeug-Seitentemplates):
[as24ci_location_box]
Hinweise
- Gibt eine leere Ausgabe zurück, wenn das Fahrzeug keine Seller ID hat oder wenn kein konfigurierter Standort mit der Seller ID übereinstimmt.
- Auf Fahrzeugdetailseiten werden diese Informationen auch automatisch unter dem Kontaktformular gerendert, sodass eine manuelle Verwendung des Shortcodes auf derselben Seite zu einer doppelten Ausgabe führen würde.
[as24ci_hours_box]
Rendert die Öffnungszeitenbox der Garage für ein Fahrzeug. Die Box zeigt eine Spalte pro konfigurierter Öffnungszeiten-Kategorie, die jeweils Zeilen für den Wochentagsbereich und den Uhrzeitbereich enthält.
Der Standort wird ermittelt, indem die AutoScout24 Seller ID des Fahrzeugs mit den konfigurierten Standorten des Plugins abgeglichen wird.
Attribute
| Attribut | Typ | Beschreibung | Beispiel |
|---|---|---|---|
post_id | int | WordPress Post-ID des Fahrzeugs. Standardmässig der aktuelle Post im Loop. | 456 |
Beispiele
Öffnungszeitenbox für ein bestimmtes Fahrzeug:
[as24ci_hours_box post_id="456"]
Öffnungszeitenbox für den aktuellen Post:
[as24ci_hours_box]
Hinweise
- Gibt eine leere Ausgabe zurück, wenn das Fahrzeug keine Seller ID hat, kein passender Standort gefunden wird oder für den passenden Standort keine Öffnungszeiten konfiguriert sind.
- Auf Fahrzeugdetailseiten werden diese Informationen auch automatisch unter dem Kontaktformular gerendert.