Dokumentation · Anhänge

Shortcode-Referenz

Dieser Anhang ist eine Schnellreferenz für die vom ADP Car Market Hub-Plugin registrierten Shortcodes.

Wann Sie dieses Dokument verwenden sollten

Verwenden Sie diese Referenz, wenn Sie einen Shortcode-Namen, seine unterstützten Attribute oder ein Copy-Paste-Beispiel nachschlagen müssen. Für die konzeptionelle Erklärung der Shortcodes (wann welcher zu verwenden ist, wie sie mit Templates interagieren) siehe Shortcodes in der technischen Dokumentation und Shortcodes-Referenz im Frontend-Handbuch.

Übersicht

Alle Shortcodes werden durch den Haupt-Bootstrap des Plugins registriert und sind auf jeder WordPress-Seite oder jedem Beitrag verfügbar (vorbehaltlich des aktiven Editors und allfälliger Einschränkungen auf Blockebene). Sie geben Strings zurück, anstatt sie direkt auszugeben, sodass sie in Bildunterschriften, Tabellenzellen oder Block-Vorlagen eingebettet werden können.

ShortcodeRendertHinweise
[as24ci_archive]Das Fahrzeugarchiv (filterbar, sortierbar, paginiert).URL-Parameter überschreiben Shortcode-Attribute.
[as24ci_search_filter]Das eigenständige Suchfilter-Formular, ohne Ergebnisse.Sendet an eine von Ihnen gewählte Ergebnis-URL.
[as24ci_compare]Die Fahrzeugvergleichsseite.Fahrzeuge werden über den URL-Parameter ids ausgewählt.
[as24ci_favorites]Die Favoritenseite des Besuchers.Wird über den Favoriten-REST-Helper geladen; Favoriten werden clientseitig gespeichert.
[as24ci_location_box]Eine Standortkarte für einen einzelnen Standort-Beitrag.Ermittelt den Standort aus post_id oder dem Kontext.
[as24ci_hours_box]Eine Öffnungszeitenkarte für einen einzelnen Standort-Beitrag.Gleiches Fallback-Verhalten wie [as24ci_location_box].

Attribut-Referenz

[as24ci_archive]

Alle Attribute sind optional. URL-Parameter mit demselben Namen überschreiben das Shortcode-Attribut, sodass Besucher die Ergebnisse interaktiv verfeinern können.

AttributErlaubte WerteWirkung
makeMarke-SlugVorfiltern nach Marke.
modelModell-SlugVorfiltern nach Modell.
price_minNummerUntergrenze des Preisfilters (zugeordnet zu min_price).
price_maxNummerObergrenze des Preisfilters (zugeordnet zu max_price).
fuelTreibstoffart-SlugVorfiltern nach Treibstoffart.
bodyKarosserieform-SlugVorfiltern nach Karosserieform.
order_byprice, mileage, dateSortierfeld. Kombiniert mit order, um den Parameter sort zu erzeugen.
orderasc, descSortierrichtung. Standardwert ist asc.
per_page12, 24, 48, 72, allEinträge pro Seite.

Die Paginierung verwendet ?paged= (bevorzugt) oder ?page= aus der URL.

Beispiel:

[as24ci_archive make="bmw" price_max="40000" order_by="price" order="asc" per_page="24"]

[as24ci_search_filter]

AttributErlaubte WerteWirkung
results_urlAbsolute oder relative URLURL, an die das Formular gesendet wird. Standardmässig die Archiv-URL des Post-Typs as24ci_car, mit Fallback auf /cars/, wenn keine Archiv-URL verfügbar ist.

Es werden nur die Filter gerendert, die im Layoutbereich Suchfilter aktiviert sind. Verwalten Sie diese im Admin-Tab Layout Manager.

Beispiel:

[as24ci_search_filter results_url="/inventory/"]

[as24ci_compare]

Keine dokumentierten Attribute im aktuellen Quellcode. Die Auswahl wird durch den URL-Parameter ids gesteuert, eine kommagetrennte Liste von Fahrzeug-Beitrags-IDs.

Beispiel-URL: /compare/?ids=123,456

[as24ci_favorites]

Keine dokumentierten Attribute. Die sichtbaren Felder werden über den Layoutbereich Favoriten im Layout Manager konfiguriert. Die Fahrzeugdaten werden von POST /wp-json/as24ci/v1/favorites für die IDs abgerufen, die der Besucher lokal gespeichert hat.

[as24ci_location_box]

AttributErlaubte WerteWirkung
post_idGanzzahlID des zu rendernden Standort-Beitrags. Wenn weggelassen, ermittelt der Shortcode den Standort aus dem aktuellen Kontext.

[as24ci_hours_box]

AttributErlaubte WerteWirkung
post_idGanzzahlID des zu rendernden Standort-Beitrags. Gleiches Fallback-Verhalten wie [as24ci_location_box].

Betriebshinweise

  • Das Plugin setzt das globale $as24ci_render_mode auf 'shortcode', während ein Shortcode-Template gerendert wird. Das Laden von Assets und Analytics nutzen dieses Flag, damit sich auf Shortcodes basierende Seiten konsistent mit dem nativen CPT-Archiv verhalten.
  • [as24ci_archive] und [as24ci_compare] tauschen das globale $wp_query aus, während ihr Template gerendert wird, und rufen danach wp_reset_postdata() auf. Betten Sie diese im Hauptinhaltsbereich ein, um Konflikte mit Theme-Komponenten zu vermeiden, die die globale Abfrage frühzeitig auslesen.
  • [as24ci_search_filter] erstellt seine action-URL aus der konfigurierten (oder standardmässigen) Ergebnis-URL und behält alle in dieser URL vorhandenen Query-Parameter über versteckte Formularfelder bei, sodass es sowohl mit schönen als auch mit einfachen Permalinks funktioniert.
  • Die mitgelieferten Archiv- und Suchfilter-Templates verwenden immer die plugin-eigenen Dateien. Theme-Overrides für archive-as24ci_car.php gelten sowohl für das CPT-Archiv als auch für [as24ci_archive], aber page-as24ci_compare.php und parts/search-filter.php werden nicht über locate_template() geladen und können nicht vom Theme aus überschrieben werden, ohne den Plugin-Quellcode zu bearbeiten. Überprüfen Sie dies vor der Veröffentlichung anhand der aktuellen Plugin-Version.
  • Seiten, die von einem Full-Page-Cache ausgeliefert werden, sollten nach dem Bearbeiten einer Seite, die diese Shortcodes verwendet, geleert werden, damit die neueste Ausgabe bereitgestellt wird.

Fehlerbehebung

  • Shortcode wird als reiner Text ausgegeben. Überprüfen Sie den Shortcode-Namen; bei Namen wird zwischen Gross- und Kleinschreibung unterschieden. Verwenden Sie die oben dokumentierte Kleinschreibung.
  • [as24ci_archive] zeigt die falschen Fahrzeuge an. Die URL enthält wahrscheinlich bereits Filterparameter von einer vorherigen Seite; URL-Parameter überschreiben immer die Shortcode-Attribute.
  • [as24ci_search_filter] zeigt keine Felder an. Im Layoutbereich Suchfilter sind keine Filter aktiviert. Öffnen Sie den Layout Manager und aktivieren Sie die benötigten Filter.
  • [as24ci_favorites] zeigt eine leere Liste an. Der Besucher hat keine Favoriten im aktuellen Browser gespeichert. Favoriten sind an den Browser/das Gerät gebunden.
  • Paginierungs-Links führen zu 404. Ihre Permalink-Struktur übergibt paged möglicherweise nicht sauber durch die Hosting-Seite. Versuchen Sie ?page=N oder aktualisieren Sie die Permalink-Struktur.
  • Vergleichsseite ist leer. Der Parameter ids fehlt in der URL. Fügen Sie mindestens zwei Fahrzeug-IDs hinzu (?ids=123,456).

Verwandte Dokumente