Documentation · Documentation développeur
Shortcodes pour les développeurs
Ce document répertorie tous les shortcodes enregistrés par l'extension ADP Car Market Hub, y compris les attributs pris en charge, le rendu généré et les options de fonctionnalités qui affectent leur disponibilité. Utilisez-le comme référence lors de l'intégration du contenu de l'extension dans des pages, des articles ou des mises en page de blocs personnalisées.
Quand utiliser ce document
Consultez ce document lorsque vous devez :
- Intégrer l'archive des véhicules, la page de comparaison, le filtre de recherche, la liste des favoris ou les blocs d'emplacement/horaires dans une page WordPress standard.
- Créer une page d'atterrissage personnalisée qui utilise l'un de ces shortcodes avec des attributs pré-remplis.
- Confirmer quelle option de fonctionnalité désactive quel shortcode.
Pour les modèles que ces shortcodes chargent, consultez le Système de modèles et surcharges. Pour les types de publication qu'ils interrogent, consultez Types de publication personnalisés et taxonomies.
Aperçu
L'extension enregistre six shortcodes. Trois affichent le catalogue public (archive, filtre de recherche, page de comparaison) ; un affiche les favoris/liste d'envies côté client ; et deux affichent les informations d'emplacement du vendeur pour le véhicule actuel.
Les shortcodes eux-mêmes constituent l'interface publique stable et prise en charge. Les classes internes qui les enregistrent et le hook WordPress utilisé pour l'enregistrement sont des détails d'implémentation et ne sont pas documentés ici.
Exigences ou prérequis
- L'extension doit être active.
- Au moins un véhicule publié pour que les shortcodes de catalogue et de comparaison produisent un résultat utile.
- L'option de fonctionnalité correspondante doit être activée dans l'interface d'administration de l'extension (voir le tableau ci-dessous).
- Pour le shortcode de comparaison, une page de comparaison (contenant
[as24ci_compare]) doit exister. L'extension en crée une lors de l'activation. - Pour le shortcode de favoris, l'option de l'API REST publique doit être activée depuis l'interface d'administration de l'extension afin que le point de terminaison des favoris soit accessible.
Référence des shortcodes
[as24ci_archive]
Affiche la même liste de véhicules que l'archive publique (/cars/), y compris les filtres, le tri et la pagination. Utilisez ce shortcode pour intégrer le catalogue dans n'importe quelle page WordPress standard ou mise en page de bloc.
Attributs
| Attribut | Valeurs autorisées | Notes |
|---|---|---|
make | string | Pré-filtrer par marque. |
model | string | Pré-filtrer par modèle. |
price_min | integer | Limite inférieure de prix. |
price_max | integer | Limite supérieure de prix. |
fuel | string | Pré-filtrer par type de carburant. |
body | string | Pré-filtrer par type de carrosserie. |
order_by | price, mileage, date | Colonne de tri. |
order | asc, desc | Direction du tri. |
per_page | 12, 24, 48, 72, all | Taille de la page. |
Les paramètres GET fournis par le visiteur (filtres, tri, pagination) surchargent les attributs du shortcode, de sorte que la liste intégrée se comporte toujours comme une archive entièrement interactive.
Restriction de fonctionnalité : aucune (le shortcode est toujours enregistré).
[as24ci_compare]
Affiche la page de comparaison de véhicules. Les véhicules sont sélectionnés par les visiteurs via des boutons de comparaison dans le catalogue et stockés côté client ; ce shortcode affiche le tableau de comparaison pour la sélection actuelle.
Attributs : aucun.
Restriction de fonctionnalité : nécessite que la fonctionnalité de comparaison soit activée dans l'interface d'administration de l'extension.
[as24ci_search_filter]
Affiche le formulaire de filtre de recherche seul (sans la liste de résultats). Utilisez-le pour créer une page d'atterrissage de recherche dédiée qui envoie les résultats vers une page distincte (par exemple une page contenant [as24ci_archive]).
Attributs
| Attribut | Valeurs autorisées | Notes |
|---|---|---|
results_url | URL | Page qui recevra les critères de recherche soumis. |
Restriction de fonctionnalité : aucune.
[as24ci_favorites]
Affiche la page des favoris/liste d'envies des clients. Les favoris sont stockés côté client et synchronisés via le point de terminaison REST de l'extension lorsque l'API REST est activée.
Attributs : aucun.
Restriction de fonctionnalité : nécessite que la fonctionnalité des favoris et l'API REST publique soient activées dans l'interface d'administration de l'extension.
[as24ci_location_box]
Affiche un bloc d'informations de localisation/contact pour un véhicule. Dans un modèle de véhicule unique, le bloc utilise le vendeur du véhicule actuel ; sur d'autres pages, fournissez un post_id.
Attributs
| Attribut | Valeurs autorisées | Notes |
|---|---|---|
post_id | integer | ID de la publication du véhicule. Par défaut, correspond à la publication actuelle lorsqu'il est utilisé dans un modèle de véhicule unique. |
Restriction de fonctionnalité : aucune, mais les informations affichées dépendent des emplacements et des données du profil du concessionnaire configurés depuis l'administration.
[as24ci_hours_box]
Affiche le bloc des heures d'ouverture pour l'emplacement associé à un véhicule. Même règle de sélection que [as24ci_location_box].
Attributs
| Attribut | Valeurs autorisées | Notes |
|---|---|---|
post_id | integer | ID de la publication du véhicule. Par défaut, correspond à la publication actuelle lorsqu'il est utilisé dans un modèle de véhicule unique. |
Restriction de fonctionnalité : aucune. Le rendu dépend des emplacements configurés.
Instructions étape par étape
Créer une page d'atterrissage de recherche dédiée
- Créez une nouvelle page WordPress qui affichera les résultats — par exemple une page nommée « Parcourir les véhicules » contenant
[as24ci_archive]. - Créez une autre page qui hébergera le formulaire de recherche — par exemple « Trouver un véhicule ».
- Ajoutez
[as24ci_search_filter results_url="/browse-cars/"]sur la page de recherche. - Publiez les deux pages et ajoutez un lien vers « Trouver un véhicule » dans votre menu.
Intégrer une liste de véhicules sélectionnée
- Sur la page où vous souhaitez afficher la liste, ajoutez
[as24ci_archive make="BMW" body="SUV" order_by="price" order="asc" per_page="12"]. - Publiez la page. Les visiteurs peuvent toujours affiner la liste à l'aide des filtres affichés ; leurs sélections surchargent les valeurs par défaut du shortcode.
Afficher la page des favoris
- Créez une page « Mes favoris ».
- Ajoutez
[as24ci_favorites]et publiez. - Confirmez que les fonctionnalités de favoris et d'API REST sont toutes deux activées dans les réglages de l'extension.
Notes opérationnelles
- Mise en file d'attente des ressources. Lorsqu'un shortcode est détecté sur une page, le chargeur de ressources de l'extension met automatiquement en file d'attente les ressources front-end correspondantes.
- Options de fonctionnalités. La désactivation de la fonctionnalité correspondante depuis l'interface d'administration empêche l'affichage de l'interface utilisateur du shortcode ou, dans le cas de
[as24ci_compare], supprime les scripts de comparaison même si le shortcode lui-même reste enregistré. - Contexte de rendu.
[as24ci_location_box]et[as24ci_hours_box]dépendent d'un contexte de véhicule. En cas d'appel en dehors d'un modèle de véhicule unique, transmettez toujourspost_id. - Gestionnaire de mise en page. L'archive des véhicules et la mise en page d'un véhicule unique sont également affectées par le gestionnaire de mise en page de l'extension, configuré depuis l'interface d'administration. L'intégration de
[as24ci_archive]réutilise la même configuration de mise en page. - Mise en cache. Si vous utilisez un cache de page complète, assurez-vous qu'il ne supprime pas le balisage dynamique ou les attributs de données en ligne utilisés par les scripts de favoris et de comparaison.
- Personnalisation. Privilégiez la surcharge des modèles modifiables par le thème (voir Système de modèles et surcharges) avant de dupliquer les modèles sous-jacents de l'extension.
Dépannage
- Liste vide lors de l'utilisation de
[as24ci_archive]. Assurez-vous qu'il y a des véhicules publiés et que les attributs restrictifs éventuels (make,model,price_min,price_max,fuel,body) ne sur-filtrent pas le résultat. Les paramètres GET du visiteur surchargent les valeurs par défaut du shortcode — testez la page dans une fenêtre de navigation privée avec une URL propre. [as24ci_compare]n'affiche rien. Confirmez que la fonctionnalité de comparaison est activée dans l'administration et que le visiteur a effectivement sélectionné des véhicules à comparer. La sélection s'effectue côté client, de sorte que différents navigateurs affichent des listes différentes.[as24ci_search_filter]ne redirige pas vers la bonne page. Confirmez que l'attributresults_urlest défini sur une URL valide de votre site. S'il est absent, le formulaire est soumis sur la page actuelle et peut ne présenter aucun résultat à moins que la page ne contienne également[as24ci_archive].[as24ci_favorites]fonctionne localement mais pas en pré-production. Confirmez que l'API REST publique est activée dans l'interface d'administration de l'extension et accessible, et qu'aucune extension de sécurité ne bloque l'espace de noms REST de l'extension.- Le bloc d'emplacement ou d'horaires est vide. Vérifiez que le vendeur du véhicule dispose de données de localisation et de champs de profil de concessionnaire configurés.
- Vérifiez le comportement dans la version actuelle de l'extension avant de publier une intégration personnalisée. Les attributs des shortcodes et le balisage généré peuvent évoluer entre les versions.