Shortcodes voor ontwikkelaars

Dit document bevat een overzicht van elke shortcode die door de ADP Car Market Hub-plugin wordt geregistreerd, inclusief de ondersteunde attributen, de gegenereerde output en de functie-instellingen die de beschikbaarheid beïnvloeden. Gebruik dit als referentie bij het insluiten van plugin-inhoud in pagina's, berichten of aangepaste bloklay-outs.

Wanneer u dit document moet gebruiken

Lees dit document wanneer u:

• Het voertuigarchief, de vergelijkingspagina, het zoekfilter, de favorietenlijst of locatie-/openingstijdenblokken wilt insluiten in een normale WordPress-pagina.
• Een aangepaste landingspagina wilt bouwen die een van deze shortcodes met vooraf ingevulde attributen gebruikt.
• Wilt controleren welke functie-instelling welke shortcode uitschakelt.

Zie Template System And Overrides voor de templates die door deze shortcodes worden geladen. Zie Custom Post Types And Taxonomies voor de post-types die ze opvragen.

Overzicht

De plugin registreert zes shortcodes. Drie daarvan tonen de openbare catalogus (archief, zoekfilter, vergelijkingspagina); één toont de favorieten/verlanglijst voor de klant; en twee tonen de locatiegegevens van de verkoper voor het huidige voertuig.

De shortcodes zelf vormen de ondersteunde, stabiele openbare interface. De interne klassen die ze registreren en de WordPress-hook die voor de registratie wordt gebruikt, zijn implementatiedetails en worden hier niet gedocumenteerd.

Vereisten of randvoorwaarden

• De plugin moet actief zijn.
• Er moet ten minste één gepubliceerd voertuig zijn om de catalogus- en vergelijkingsshortcodes van nuttige output te voorzien.
• De relevante functie-instelling moet zijn ingeschakeld in de beheeromgeving van de plugin (zie de tabel hieronder).
• Voor de vergelijkingsshortcode moet er een vergelijkingspagina (die [as24ci_compare] bevat) bestaan. De plugin maakt er een aan bij activering.
• Voor de favorietenshortcode moet de openbare REST API-optie zijn ingeschakeld in de beheeromgeving van de plugin, zodat het favorieten-endpoint bereikbaar is.

Shortcode-referentie

[as24ci_archive]

Toont dezelfde voertuiglijst als het openbare archief (/cars/), inclusief filters, sortering en paginering. Gebruik deze shortcode om de catalogus in te sluiten in een normale WordPress-pagina of bloklay-out.

Attributen

GET-parameters die door de bezoeker worden meegegeven (filters, sortering, paginering) overschrijven de shortcode-attributen, waardoor de ingesloten lijst zich nog steeds gedraagt als een volledig interactief archief.

Functiebeperking: geen (de shortcode is altijd geregistreerd).

[as24ci_compare]

Toont de voertuigvergelijkingspagina. Voertuigen worden door bezoekers geselecteerd via vergelijkingsknoppen in de catalogus en aan de clientzijde opgeslagen; deze shortcode toont de vergelijkingstabel voor de huidige selectie.

Attributen: geen.

Functiebeperking: vereist dat de vergelijkingsfunctie is ingeschakeld in de beheeromgeving van de plugin.

[as24ci_search_filter]

Toont alleen het zoekfilterformulier (zonder de resultatenlijst). Gebruik dit om een speciale zoeklandingspagina te bouwen die resultaten doorstuurt naar een aparte pagina (bijvoorbeeld een pagina die [as24ci_archive] bevat).

Attributen

Functiebeperking: geen.

[as24ci_favorites]

Toont de favorieten-/verlanglijstpagina voor de klant. Favorieten worden aan de clientzijde opgeslagen en gesynchroniseerd via het REST-endpoint van de plugin wanneer de REST API is ingeschakeld.

Attributen: geen.

Functiebeperking: vereist dat de favorietenfunctie en de openbare REST API zijn ingeschakeld in de beheeromgeving van de plugin.

[as24ci_location_box]

Toont een box met locatie-/contactgegevens voor een voertuig. Binnen een template voor één voertuig gebruikt de box de verkoper van het huidige voertuig; geef op andere pagina's een post_id op.

Attributen

Functiebeperking: geen, maar de getoonde informatie is afhankelijk van de locaties en dealerprofielgegevens die in het beheer zijn geconfigureerd.

[as24ci_hours_box]

Toont de openingstijdenbox voor de locatie die aan een voertuig is gekoppeld. Dezelfde selectieregel als bij [as24ci_location_box].

Attributen

Functiebeperking: geen. De output is afhankelijk van de geconfigureerde locaties.

Stapsgewijze instructies

Een speciale zoeklandingspagina bouwen

1. Maak een nieuwe WordPress-pagina aan die de resultaten zal tonen — bijvoorbeeld een pagina genaamd "Auto's bekijken" die [as24ci_archive] bevat.
2. Maak een andere pagina aan die het zoekformulier zal bevatten — bijvoorbeeld "Auto zoeken".
3. Voeg [as24ci_search_filter results_url="/browse-cars/"] toe aan de zoekpagina.
4. Publiceer beide pagina's en link naar "Auto zoeken" vanuit uw menu.

Een gecureerde lijst met voertuigen insluiten

1. Voeg op de pagina waar u de lijst wilt tonen [as24ci_archive make="BMW" body="SUV" order_by="price" order="asc" per_page="12"] toe.
2. Publiceer de pagina. Bezoekers kunnen de lijst nog steeds verfijnen met de getoonde filters; hun selecties overschrijven de standaardwaarden van de shortcode.

De favorietenpagina tonen

1. Maak een pagina "Mijn favorieten" aan.
2. Voeg [as24ci_favorites] toe en publiceer de pagina.
3. Controleer of zowel de favorieten- als de REST-functies zijn ingeschakeld in de plugin-instellingen.

Operationele opmerkingen

• Assets in de wachtrij plaatsen. Wanneer een shortcode op een pagina wordt gedetecteerd, plaatst de asset-loader van de plugin automatisch de bijbehorende frontend-assets in de wachtrij.
• Functie-instellingen. Het uitschakelen van de bijbehorende functie in de beheeromgeving voorkomt dat de UI van de shortcode verschijnt of, in het geval van [as24ci_compare], onderdrukt de vergelijkingsscripts, hoewel de shortcode zelf geregistreerd blijft.
• Render-context. [as24ci_location_box] en [as24ci_hours_box] zijn afhankelijk van een voertuigcontext. Geef altijd post_id mee wanneer deze buiten een template voor één voertuig worden aangeroepen.
• Layout Manager. Het voertuigarchief en de lay-out voor één voertuig worden ook beïnvloed door de Layout Manager van de plugin, geconfigureerd in de beheeromgeving. Het insluiten van [as24ci_archive] hergebruikt dezelfde lay-outconfiguratie.
• Caching. Als u een volledige-paginacache gebruikt, zorg er dan voor dat deze de dynamische markup of de inline data-attributen die door de favorieten- en vergelijkingsscripts worden gebruikt, niet verwijdert.
• Aanpassingen. Geef de voorkeur aan het overschrijven van templates die door het thema kunnen worden overschreven (zie Template System And Overrides) voordat u de onderliggende plugin-templates forkt.

Probleemoplossing

• Lege lijst bij gebruik van [as24ci_archive]. Zorg ervoor dat er gepubliceerde voertuigen zijn en dat eventuele beperkende attributen (make, model, price_min, price_max, fuel, body) het resultaat niet te streng filteren. GET-parameters van bezoekers overschrijven de standaardwaarden van de shortcode — probeer de pagina in een privévenster met een schone URL.
• [as24ci_compare] toont niets. Controleer of de vergelijkingsfunctie is ingeschakeld in het beheer en of de bezoeker daadwerkelijk voertuigen heeft geselecteerd om te vergelijken. De selectie vindt plaats aan de clientzijde, dus verschillende browsers zien verschillende lijsten.
• [as24ci_search_filter] stuurt niet door naar de juiste pagina. Controleer of het attribuut results_url is ingesteld op een geldige URL op uw site. Indien afwezig, verzendt het formulier naar de huidige pagina en worden er mogelijk geen resultaten getoond, tenzij de pagina ook [as24ci_archive] bevat.
• [as24ci_favorites] werkt lokaal, maar niet op staging. Controleer of de openbare REST API is ingeschakeld in de beheeromgeving van de plugin en bereikbaar is, en dat er geen beveiligingsplugin is die de REST-namespace van de plugin blokkeert.
• Locatie- of openingstijdenbox is leeg. Controleer of de verkoper van het voertuig locatiegegevens en dealerprofielvelden heeft geconfigureerd.
• Verifieer het gedrag in de huidige plugin-versie voordat u een aangepaste integratie publiceert. Shortcode-attributen en gegenereerde markup kunnen tussen releases veranderen.

Gerelateerde documenten

• Template System And Overrides
• Custom Post Types And Taxonomies
• Frontend Assets
• REST API For Developers
• AJAX Actions For Developers
• Option Keys And Settings Storage