Documentación · Documentación para desarrolladores
Shortcodes para desarrolladores
Este documento enumera todos los shortcodes registrados por el plugin ADP Car Market Hub, incluidos los atributos admitidos, el resultado renderizado y los selectores de funciones que afectan a su disponibilidad. Utilícelo como referencia al incrustar contenido del plugin dentro de páginas, entradas o diseños de bloques personalizados.
Cuándo utilizar este documento
Lea este documento cuando necesite:
- Incrustar el archivo de vehículos, la página de comparación, el filtro de búsqueda, la lista de favoritos o los bloques de ubicación/horarios dentro de una página normal de WordPress.
- Crear una página de destino personalizada que utilice uno de estos shortcodes con atributos precompletados.
- Confirmar qué selector de funciones desactiva cada shortcode.
Para conocer las plantillas que cargan estos shortcodes, consulte Template System And Overrides. Para conocer los tipos de contenido personalizados que consultan, consulte Custom Post Types And Taxonomies.
Descripción general
El plugin registra seis shortcodes. Tres renderizan el catálogo público (archivo, filtro de búsqueda, página de comparación); uno renderiza los favoritos/lista de deseos orientados al cliente; y dos renderizan la información de ubicación del vendedor para el vehículo actual.
Los propios shortcodes constituyen la interfaz pública estable y admitida. Las clases internas que los registran y el hook WordPress utilizado para el registro son detalles de implementación y no se documentan aquí.
Requisitos o prerrequisitos
- El plugin debe estar activo.
- Al menos un vehículo publicado para que los shortcodes de catálogo y comparación produzcan un resultado útil.
- El selector de funciones correspondiente debe estar habilitado en la interfaz de administración del plugin (consulte la tabla siguiente).
- Para el shortcode de comparación, debe existir una página de comparación (que contenga
[as24ci_compare]). El plugin crea una al activarse. - Para el shortcode de favoritos, el selector de la API REST pública debe estar habilitado desde la interfaz de administración del plugin para que el endpoint de favoritos sea accesible.
Referencia de shortcodes
[as24ci_archive]
Renderiza la misma lista de vehículos que el archivo público (/cars/), incluyendo filtros, ordenación y paginación. Utilice este shortcode para incrustar el catálogo dentro de cualquier página o diseño de bloques normal de WordPress.
Atributos
| Atributo | Valores permitidos | Notas |
|---|---|---|
make | string | Prefiltrar por marca. |
model | string | Prefiltrar por modelo. |
price_min | integer | Límite inferior de precio. |
price_max | integer | Límite superior de precio. |
fuel | string | Prefiltrar por tipo de combustible. |
body | string | Prefiltrar por tipo de carrocería. |
order_by | price, mileage, date | Columna de ordenación. |
order | asc, desc | Dirección de ordenación. |
per_page | 12, 24, 48, 72, all | Tamaño de página. |
Los parámetros GET proporcionados por el visitante (filtros, ordenación, paginación) anulan los atributos del shortcode, por lo que la lista incrustada sigue comportándose como un archivo totalmente interactivo.
Restricción de función: ninguna (el shortcode siempre está registrado).
[as24ci_compare]
Renderiza la página de comparación de vehículos. Los visitantes seleccionan los vehículos mediante los botones de comparación del catálogo y estos se almacenan en el lado del cliente; este shortcode muestra la tabla de comparación para la selección actual.
Atributos: ninguno.
Restricción de función: requiere que la función de comparación esté habilitada en la interfaz de administración del plugin.
[as24ci_search_filter]
Renderiza el formulario de filtro de búsqueda por sí solo (sin la lista de resultados). Utilícelo para crear una página de destino de búsqueda dedicada que envíe los resultados a una página independiente (por ejemplo, una página que contenga [as24ci_archive]).
Atributos
| Atributo | Valores permitidos | Notas |
|---|---|---|
results_url | URL | Página que recibirá los criterios de búsqueda enviados. |
Restricción de función: ninguna.
[as24ci_favorites]
Renderiza la página de favoritos/lista de deseos orientada al cliente. Los favoritos se almacenan en el lado del cliente y se sincronizan a través del endpoint REST del plugin cuando la API REST está habilitada.
Atributos: ninguno.
Restricción de función: requiere que la función de favoritos y la API REST pública estén habilitadas en la interfaz de administración del plugin.
[as24ci_location_box]
Renderiza un cuadro de información de ubicación/contacto para un vehículo. Dentro de una plantilla de vehículo individual, el cuadro utiliza el vendedor del vehículo actual; en otras páginas, proporcione un post_id.
Atributos
| Atributo | Valores permitidos | Notas |
|---|---|---|
post_id | integer | ID de la entrada del vehículo. Por defecto es la entrada actual cuando se usa dentro de una plantilla de vehículo individual. |
Restricción de función: ninguna, pero la información mostrada depende de las ubicaciones y de los datos del perfil del distribuidor configurados desde la administración.
[as24ci_hours_box]
Renderiza el cuadro de horarios de apertura para la ubicación asociada a un vehículo. Misma regla de selección que [as24ci_location_box].
Atributos
| Atributo | Valores permitidos | Notas |
|---|---|---|
post_id | integer | ID de la entrada del vehículo. Por defecto es la entrada actual cuando se usa dentro de una plantilla de vehículo individual. |
Restricción de función: ninguna. El resultado depende de las ubicaciones configuradas.
Instrucciones paso a paso
Crear una página de destino de búsqueda dedicada
- Cree una nueva página de WordPress que mostrará los resultados; por ejemplo, una página llamada "Buscar coches" que contenga
[as24ci_archive]. - Cree otra página que albergará el formulario de búsqueda; por ejemplo, "Encontrar un coche".
- Añada
[as24ci_search_filter results_url="/browse-cars/"]a la página de búsqueda. - Publique ambas páginas y enlace a "Encontrar un coche" desde su menú.
Incrustar una lista seleccionada de vehículos
- En la página donde desee la lista, añada
[as24ci_archive make="BMW" body="SUV" order_by="price" order="asc" per_page="12"]. - Publique la página. Los visitantes aún pueden refinar la lista utilizando los filtros mostrados; sus selecciones anulan los valores predeterminados del shortcode.
Mostrar la página de favoritos
- Cree una página "Mis favoritos".
- Añada
[as24ci_favorites]y publique. - Confirme que las funciones de favoritos y REST estén habilitadas en los ajustes del plugin.
Notas de funcionamiento
- Encolado de recursos (assets). Cuando se detecta un shortcode en una página, el cargador de recursos del plugin encola automáticamente los recursos front-end correspondientes.
- Selectores de funciones. Desactivar la función correspondiente desde la interfaz de administración evita que aparezca la interfaz de usuario del shortcode o, en el caso de
[as24ci_compare], suprime los scripts de comparación aunque el propio shortcode permanezca registrado. - Contexto de renderizado.
[as24ci_location_box]y[as24ci_hours_box]dependen del contexto de un vehículo. Cuando se llamen fuera de una plantilla de vehículo individual, pase siemprepost_id. - Gestor de diseño. El archivo de vehículos y el diseño de vehículo individual también se ven afectados por el gestor de diseño del plugin, configurado desde la interfaz de administración. Incrustar
[as24ci_archive]reutiliza la misma configuración de diseño. - Caché. Si utiliza una caché de página completa, asegúrese de que no elimine el marcado dinámico o los atributos de datos en línea utilizados por los scripts de favoritos y comparación.
- Personalización. Prefiera sobrescribir las plantillas que admiten modificaciones en el tema (consulte Template System And Overrides) antes de realizar un fork de las plantillas base del plugin.
Resolución de problemas
- Lista vacía al usar
[as24ci_archive]. Asegúrese de que haya vehículos publicados y de que ningún atributo restrictivo (make,model,price_min,price_max,fuel,body) esté filtrando en exceso el resultado. Los parámetros GET del visitante anulan los valores predeterminados del shortcode; pruebe la página en una ventana privada con una URL limpia. [as24ci_compare]no muestra nada. Confirme que la función de comparación está habilitada en la administración y que el visitante realmente ha seleccionado vehículos para comparar. La selección se realiza en el lado del cliente, por lo que diferentes navegadores verán diferentes listas.[as24ci_search_filter]no redirige a la página correcta. Confirme que el atributoresults_urlestá configurado con una URL válida de su sitio. Si no está presente, el formulario se envía a la página actual y puede no mostrar resultados a menos que la página también contenga[as24ci_archive].[as24ci_favorites]funciona en local pero no en el entorno de pruebas (staging). Confirme que la API REST pública está habilitada en la interfaz de administración del plugin y es accesible, y que ningún plugin de seguridad está bloqueando el espacio de nombres REST del plugin.- El cuadro de ubicación u horarios está vacío. Verifique que el vendedor del vehículo tenga configurados los datos de ubicación y los campos del perfil del distribuidor.
- Verifique el comportamiento en la versión actual del plugin antes de publicar una integración personalizada. Los atributos de los shortcodes y el marcado renderizado pueden evolucionar entre versiones.