Documentazione · Documentazione per gli sviluppatori
Shortcode per gli sviluppatori
Questo documento elenca ogni shortcode registrato dal plugin ADP Car Market Hub, inclusi gli attributi supportati, l'output generato e i selettori di funzionalità che ne influenzano la disponibilità. Utilizzalo come riferimento quando inserisci i contenuti del plugin all'interno di pagine, articoli o layout di blocchi personalizzati.
Quando utilizzare questo documento
Leggi questo documento quando hai bisogno di:
- Incorporare l'archivio dei veicoli, la pagina di confronto, il filtro di ricerca, la lista dei preferiti o i blocchi relativi a posizione/orari all'interno di una normale pagina WordPress.
- Creare una landing page personalizzata che utilizzi uno di questi shortcode con attributi precompilati.
- Verificare quale selettore di funzionalità disabilita un determinato shortcode.
Per i template caricati da questi shortcode, consulta Template System And Overrides. For the post types they query, see Custom Post Types And Taxonomies.
Panoramica
Il plugin registra sei shortcode. Tre mostrano il catalogo pubblico (archivio, filtro di ricerca, pagina di confronto); uno mostra i preferiti/lista dei desideri lato cliente; e due mostrano le informazioni sulla posizione del venditore per il veicolo corrente.
Gli shortcode stessi rappresentano l'interfaccia pubblica stabile e supportata. Le classi interne che li registrano e l'hook WordPress utilizzato per la registrazione sono dettagli di implementazione e non sono documentati qui.
Requisiti o prerequisiti
- Il plugin deve essere attivo.
- Almeno un veicolo pubblicato affinché gli shortcode del catalogo e del confronto producano un output utile.
- Il relativo selettore di funzionalità deve essere abilitato nell'interfaccia di amministrazione del plugin (vedi la tabella seguente).
- Per lo shortcode di confronto, deve esistere una pagina di confronto (contenente
[as24ci_compare]). Il plugin ne crea una all'attivazione. - Per lo shortcode dei preferiti, il selettore delle API REST pubbliche deve essere abilitato nell'interfaccia di amministrazione del plugin in modo che l'endpoint dei preferiti sia raggiungibile.
Riferimento shortcode
[as24ci_archive]
Mostra lo stesso elenco di veicoli dell'archivio pubblico (/cars/), inclusi filtri, ordinamento e paginazione. Utilizza questo shortcode per incorporare il catalogo all'interno di qualsiasi normale pagina WordPress o layout a blocchi.
Attributi
| Attributo | Valori consentiti | Note |
|---|---|---|
make | string | Pre-filtra per marca. |
model | string | Pre-filtra per modello. |
price_min | integer | Limite inferiore di prezzo. |
price_max | integer | Limite superiore di prezzo. |
fuel | string | Pre-filtra per tipo di carburante. |
body | string | Pre-filtra per tipo di carrozzeria. |
order_by | price, mileage, date | Colonna di ordinamento. |
order | asc, desc | Direzione dell'ordinamento. |
per_page | 12, 24, 48, 72, all | Dimensione della pagina. |
I parametri GET forniti dal visitatore (filtri, ordinamento, paginazione) sovrascrivono gli attributi dello shortcode, in modo che l'elenco incorporato continui a comportarsi come un archivio completamente interattivo.
Limitazione funzionalità: nessuna (lo shortcode è sempre registrato).
[as24ci_compare]
Mostra la pagina di confronto dei veicoli. I veicoli vengono selezionati dai visitatori tramite i pulsanti di confronto nel catalogo e memorizzati lato client; questo shortcode mostra la tabella di confronto per la selezione corrente.
Attributi: nessuno.
Limitazione funzionalità: richiede che la funzionalità di confronto sia abilitata nell'interfaccia di amministrazione del plugin.
[as24ci_search_filter]
Mostra il modulo del filtro di ricerca da solo (senza l'elenco dei risultati). Utilizzalo per creare una landing page di ricerca dedicata che invii i risultati a una pagina separata (ad esempio una pagina che contiene [as24ci_archive]).
Attributi
| Attributo | Valori consentiti | Note |
|---|---|---|
results_url | URL | Pagina che riceverà i criteri di ricerca inviati. |
Limitazione funzionalità: nessuna.
[as24ci_favorites]
Mostra la pagina dei preferiti/lista dei desideri lato cliente. I preferiti sono memorizzati lato client e sincronizzati tramite l'endpoint REST del plugin quando l'API REST è abilitata.
Attributi: nessuno.
Limitazione funzionalità: richiede che la funzionalità dei preferiti e l'API REST pubblica siano abilitate nell'interfaccia di amministrazione del plugin.
[as24ci_location_box]
Mostra un box con le informazioni di contatto/posizione per un veicolo. All'interno del template del singolo veicolo, il box utilizza il venditore del veicolo corrente; su altre pagine, fornisci un post_id.
Attributi
| Attributo | Valori consentiti | Note |
|---|---|---|
post_id | integer | ID dell'articolo del veicolo. Il valore predefinito è l'articolo corrente quando utilizzato all'interno di un template di un singolo veicolo. |
Limitazione funzionalità: nessuna, ma le informazioni visualizzate dipendono dalle sedi e dai dati del profilo del concessionario configurati dall'amministratore.
[as24ci_hours_box]
Mostra il box degli orari di apertura per la sede associata a un veicolo. Stessa regola di selezione di [as24ci_location_box].
Attributi
| Attributo | Valori consentiti | Note |
|---|---|---|
post_id | integer | ID dell'articolo del veicolo. Il valore predefinito è l'articolo corrente quando utilizzato all'interno di un template di un singolo veicolo. |
Limitazione funzionalità: nessuna. L'output dipende dalle sedi configurate.
Istruzioni passo dopo passo
Creare una landing page di ricerca dedicata
- Crea una nuova pagina WordPress che mostrerà i risultati, ad esempio una pagina chiamata "Sfoglia auto" che contiene
[as24ci_archive]. - Crea un'altra pagina che ospiterà il modulo di ricerca, ad esempio "Trova un'auto".
- Aggiungi
[as24ci_search_filter results_url="/browse-cars/"]alla pagina di ricerca. - Pubblica entrambe le pagine e inserisci il link a "Trova un'auto" nel tuo menu.
Incorporare un elenco curato di veicoli
- Nella pagina in cui desideri inserire l'elenco, aggiungi
[as24ci_archive make="BMW" body="SUV" order_by="price" order="asc" per_page="12"]. - Pubblica la pagina. I visitatori possono comunque affinare l'elenco utilizzando i filtri visualizzati; le loro selezioni sovrascrivono i valori predefiniti dello shortcode.
Mostrare la pagina dei preferiti
- Crea una pagina "I miei preferiti".
- Aggiungi
[as24ci_favorites]e pubblica. - Verifica che le funzionalità dei preferiti e REST siano entrambe abilitate nelle impostazioni del plugin.
Note operative
- Accodamento degli asset. Quando viene rilevato uno shortcode su una pagina, il caricatore di asset del plugin accoda automaticamente gli asset front-end corrispondenti.
- Selettori di funzionalità. Disabilitare la funzionalità corrispondente dall'interfaccia di amministrazione impedisce la visualizzazione dell'interfaccia utente dello shortcode o, nel caso di
[as24ci_compare], sopprime gli script di confronto anche se lo shortcode stesso rimane registrato. - Contesto di rendering.
[as24ci_location_box]e[as24ci_hours_box]si basano sul contesto di un veicolo. Se richiamati al di fuori del template di un singolo veicolo, passa semprepost_id. - Layout manager. L'archivio dei veicoli e il layout del singolo veicolo sono influenzati anche dal layout manager del plugin, configurato dall'interfaccia di amministrazione. L'incorporamento di
[as24ci_archive]riutilizza la stessa configurazione di layout. - Caching. Se utilizzi una cache di pagina intera (full-page cache), assicurati che non rimuova il markup dinamico o gli attributi di dati inline utilizzati dagli script dei preferiti e del confronto.
- Personalizzazione. Preferisci l'override dei template sovrascrivibili dal tema (vedi Template System And Overrides) prima di effettuare il fork dei template del plugin sottostante.
Risoluzione dei problemi
- Elenco vuoto quando si usa
[as24ci_archive]. Assicurati che ci siano veicoli pubblicati e che gli attributi restrittivi (make,model,price_min,price_max,fuel,body) non stiano filtrando eccessivamente il risultato. I parametri GET del visitatore sovrascrivono i valori predefiniti dello shortcode: prova a visualizzare la pagina in una finestra di navigazione in incognito con un URL pulito. [as24ci_compare]non mostra nulla. Verifica che la funzionalità di confronto sia abilitata nell'amministrazione e che il visitatore abbia effettivamente selezionato dei veicoli da confrontare. La selezione avviene lato client, quindi browser diversi vedranno elenchi diversi.[as24ci_search_filter]non reindirizza alla pagina corretta. Verifica che l'attributoresults_urlsia impostato su un URL valido sul tuo sito. Se assente, il modulo invia i dati alla pagina corrente e potrebbe non mostrare risultati a meno che la pagina non contenga anche[as24ci_archive].[as24ci_favorites]funziona in locale ma non in staging. Verifica che l'API REST pubblica sia abilitata nell'interfaccia di amministrazione del plugin e sia raggiungibile, e che nessun plugin di sicurezza stia bloccando il namespace REST del plugin.- Il box della posizione o degli orari è vuoto. Verifica che il venditore del veicolo disponga dei dati sulla posizione e dei campi del profilo del concessionario configurati.
- Verifica il comportamento nella versione corrente del plugin prima di pubblicare un'integrazione personalizzata. Gli attributi dello shortcode e il markup generato possono evolvere tra una versione e l'altra.