Documentatie · Technische documentatie

Shortcodes

Dit document bevat een overzicht van de shortcodes die door de ADP Car Market Hub-plugin worden geregistreerd, hun attributen en de typische use-cases voor het insluiten van plugin-output in gewone WordPress-pagina's.

Wanneer u dit document moet gebruiken

Lees dit document als u het volgende wilt doen:

  • Het voertuigarchief, de zoekfilter of de vergelijkingsweergave insluiten in een bestaande landingspagina, in plaats van te vertrouwen op het CPT-archief.
  • Een favorietenpagina toevoegen aan een normale WordPress-pagina.
  • Een locatiekaart of openingstijdenkaart op dealerpagina's plaatsen.
  • De ondersteunde attributen voor een bestaande shortcode opzoeken.

Zie het Frontend-sjabloonsysteem voor de onderliggende template-laadstroom.

Overzicht

De plugin registreert de volgende shortcodes:

ShortcodeRendert
[as24ci_archive]Het voertuigarchief (filterbaar, sorteerbaar, gepagineerd).
[as24ci_search_filter]Het zelfstandige zoekfilterformulier, zonder resultaten.
[as24ci_compare]De voertuigvergelijkingspagina.
[as24ci_favorites]De favorietenpagina van de bezoeker.
[as24ci_location_box]Een locatiekaart voor een enkele locatie-post.
[as24ci_hours_box]Een openingstijdenkaart voor een enkele locatie-post.

Alle shortcodes kunnen op standaard pagina's, berichten en de meeste op blokken gebaseerde inhoud worden geplaatst. Ze gebruiken dezelfde templates en assets als de eigen pagina's van de plugin.

Shortcode-referentie

[as24ci_archive]

Toont het voertuigarchief op elke gewenste pagina.

  • Gedrag: Bouwt een WP_Query op basis van $_GET-parameters via dezelfde logica die wordt gebruikt door het CPT-archief (Archive_Filters::build_query_args_from_request()), wisselt tijdelijk de globale $wp_query en rendert de gebundelde archive-as24ci_car.php-template. De originele query wordt daarna hersteld.
  • Attributen (allemaal optioneel, allemaal te overschrijven via URL):
  • make, model — vooraf ingesteld merk / model.
  • price_min, price_max — grenzen van het prijsbereik (gekoppeld aan min_price, max_price).
  • fuel, body — slugs voor brandstof en carrosserievorm.
  • order_by — price, mileage of date. Gecombineerd met order om de parameter sort te produceren.
  • order — asc (standaard) of desc.
  • per_page — 12, 24, 48, 72 of all.
  • URL-parameters overschrijven attributen zodat bezoekers hun zoekopdracht interactief kunnen verfijnen.
  • Paginering: leest ?paged= (voorkeur) of ?page= uit de URL.

[as24ci_search_filter]

Rendert het zoekfilterformulier (zonder resultaten) zodat bezoekers criteria kunnen kiezen voordat ze naar een resultatenpagina worden geleid.

  • Attributen:
  • results_url — URL waarnaar het formulier verzendt. Standaard ingesteld op de as24ci_car post-type archief-URL, met een definitieve fallback naar /cars/ wanneer er geen archief-URL beschikbaar is.
  • Filterset: alleen de filters die zijn ingeschakeld in de lay-outzone Zoekfilters worden gerenderd. Beheer deze in de Filters-configuratie in de admin.
  • Statusaantallen: het formulier toont live aantallen voor alle, nieuw en gebruikt met behulp van dezelfde op taxonomie gebaseerde query die het archief gebruikt, zodat aantallen en resultaten consistent blijven.

[as24ci_compare]

Rendert de voertuigvergelijkingspagina (page-as24ci_compare.php).

  • Selectie: voertuigen worden geselecteerd via de GET-parameter ids (komma-gescheiden post-ID's).
  • Attributen: geen gedocumenteerd in de huidige bron; verifieer dit voor publicatie als u van plan bent attributen bloot te stellen.

[as24ci_favorites]

Rendert de favorietenpagina van de bezoeker. De lijst met favorieten wordt client-side opgeslagen in de browser van de bezoeker; de shortcode (en de bijbehorende REST-endpoint) vult die lijst aan met actuele voertuiggegevens.

  • Gedrag: laadt de favorieten-stylesheet op aanvraag in de wachtrij en vult voertuiggegevens aan vanuit POST /wp-json/as24ci/v1/favorites.
  • Zichtbare velden: geconfigureerd door de lay-outzone Favorieten in de Filters-configuratie in de admin.

[as24ci_location_box]

Rendert een locatie-overzichtskaart voor een enkele locatie-post.

  • Attributen:
  • post_id — ID van de te renderen locatie-post. Indien weggelaten, probeert de shortcode de locatie te bepalen op basis van de huidige context.

[as24ci_hours_box]

Rendert een openingstijdenkaart voor een enkele locatie-post.

  • Attributen:
  • post_id — ID van de te renderen locatie-post. Zelfde fallback-gedrag als [as24ci_location_box].

Stapsgewijze instructies

  1. Open of maak de pagina waar u de shortcode wilt insluiten.
  2. Voeg het shortcode-blok toe (of plak de shortcode-string in een klassieke editor).
  3. Stel de gewenste attributen in. Bijvoorbeeld: - [as24ci_archive make="audi" per_page="24"] - [as24ci_search_filter results_url="/inventory/"] - [as24ci_location_box post_id="42"]
  4. Publiceer of bekijk een voorbeeld van de pagina en controleer de weergave.
  5. Als de shortcode zich op een pagina bevindt die door een paginacache wordt bediend, leeg dan de cache na het bewerken zodat de nieuwste output wordt getoond.

Operationele opmerkingen

  • De plugin stelt de globale $as24ci_render_mode in op 'shortcode' terwijl een shortcode-template rendert. Dit wordt gebruikt door andere delen of de plugin (laden van assets, analytics) zodat op shortcodes gebaseerde pagina's zich consistent gedragen met het native CPT-archief.
  • [as24ci_archive] en [as24ci_compare] wisselen de globale $wp_query terwijl hun template wordt ingeladen en roepen daarna wp_reset_postdata() aan. Sluit ze in binnen het hoofdgedeelte van de inhoud om te voorkomen dat ze interfereren met thema-componenten die de globale query vroegtijdig lezen.
  • [as24ci_search_filter] bouwt zijn action-URL op basis van de geconfigureerde (of standaard) resultaten-URL en behoudt eventuele queryparameters die in die URL aanwezig zijn via verborgen formuliervelden, zodat het werkt met zowel mooie als eenvoudige permalinks.
  • De gebundelde archief- en zoekfiltertemplates gebruiken altijd de eigen bestanden van de plugin. Thema-overschrijvingen voor archive-as24ci_car.php zijn van toepassing op zowel het CPT-archief als de [as24ci_archive] shortcode, maar page-as24ci_compare.php en parts/search-filter.php worden niet geladen via locate_template() — ze kunnen niet vanuit een thema worden overschreven zonder de plugin-broncode te wijzigen. Zie Sjabloon-overschrijvingen.
  • Alle shortcodes retourneren strings (geen directe echo), zodat ze kunnen worden ingesloten in bijschriften, tabelcellen of blokpatronen.

Probleemoplossing

  • Shortcode toont platte tekst — controleer de naam van de shortcode op typofouten. Namen zijn hoofdlettergevoelig; gebruik de hierboven gedocumenteerde kleine letters.
  • [as24ci_archive] toont de verkeerde voertuigen — controleer of de URL niet al filterparameters van een vorige pagina bevat; URL-parameters overschrijven altijd shortcode-attributen.
  • [as24ci_search_filter] toont geen velden — er zijn geen filters ingeschakeld in de zone Zoekfilters. Open de Filters-configuratie in de admin en schakel de filters in die u nodig hebt.
  • [as24ci_favorites] toont een lege lijst — de bezoeker heeft geen favorieten opgeslagen in de huidige browser. Probeer eerst een voertuig als favoriet te markeren; favorieten zijn gekoppeld aan de browser/het apparaat.
  • Paginering-links van [as24ci_archive] geven een 404-fout — uw permalink-structuur geeft paged mogelijk niet correct door via de hostpagina. Probeer ?page=N te gebruiken of update de permalink-structuur.
  • Vergelijkingspagina is leeg — de parameter ids ontbreekt in de URL. Voeg ten minste twee voertuig-ID's toe: ?ids=123,456.

Gerelateerde documenten