Arquitectura
Comprenda la estructura del plugin, el ciclo de vida, el modelo de datos y las responsabilidades técnicas antes de extender o integrar.
Arquitectura del plugin para desarrolladoresDOCUMENTACIÓN PARA DESARROLLADORES
Notas técnicas para desarrolladores sobre la integración de ADP Car Market Hub
Explore la documentación pública para desarrolladores de ADP Car Market Hub, incluyendo arquitectura, hooks, filtros, referencias de API REST, acciones AJAX, hooks de cron, sobrescrituras de plantillas, directrices de seguridad, depuración y flujo de lanzamiento.
Visión general de la documentación para desarrolladores
La documentación para desarrolladores ofrece a los implementadores técnicos un punto de entrada estructurado a la arquitectura del plugin, puntos de extensión, comportamiento de endpoints y flujos de personalización seguros.
Puntos de extensión
Use acciones, filtros, hooks y puntos de extensión documentados en lugar de editar archivos del núcleo del plugin.
Hooks y filtrosAPI y procesamiento en segundo plano
Revise el comportamiento de la API REST, las acciones AJAX, los hooks de cron y los límites del procesamiento programado.
API REST para desarrolladoresPlantillas y recursos del frontend
Use sobrescrituras de plantillas, recursos del frontend y comportamiento de shortcodes para personalizar la salida de forma segura.
Sistema de plantillas y sobrescriturasSeguridad y flujo de lanzamiento
Siga las verificaciones de capacidad, saneamiento, escape, pruebas y orientación de lanzamiento antes de desplegar cambios.
Verificaciones de seguridad y capacidadPuntos de entrada para desarrolladores
Comience con los documentos que coincidan con su rol y tarea de implementación.
Incorporación de nuevos desarrolladores
Primeros pasos
Arquitectura del plugin
Arquitectura
Desarrollo de extensiones
Puntos de extensión
Personalización del frontend
Frontend
Arquitectura y orientación del código
Antes de añadir integraciones o personalizaciones, los desarrolladores deben comprender el ciclo de vida del plugin, la estructura del repositorio, el modelo de datos y el comportamiento del almacenamiento.
Temas de arquitectura principal
- Ciclo de vida del plugin
- Estructura del repositorio
- Modelo de datos
- Tablas de base de datos
- Almacenamiento de opciones y configuración
- Tipos de entrada personalizados y taxonomías
- Motor de importación
- Cola de importación de imágenes
- Programador cron
Puntos de extensión
Las integraciones personalizadas deben usar puntos de extensión documentados en lugar de modificar archivos del núcleo del plugin.
| Área de extensión | Caso de uso | Documento recomendado |
|---|---|---|
| Acciones | Reaccione a eventos del plugin o pasos de procesamiento | Referencia de acciones |
| Filtros | Modifique valores o salida a través de puntos de filtro controlados | Referencia de filtros |
| Visión general de hooks y filtros | Comprenda los mecanismos de extensión disponibles | Hooks y filtros |
| Puntos de extensión del motor de importación | Extienda o ajuste el comportamiento relacionado con la importación de forma segura | Puntos de extensión del motor de importación |
| Puntos de extensión de importación de imágenes | Personalice la gestión de imágenes o el comportamiento de la cola donde esté soportado | Puntos de extensión de importación de imágenes |
| Puntos de extensión del procesamiento de leads | Integre la gestión de leads con flujos de trabajo externos | Puntos de extensión del procesamiento de leads |
| Puntos de extensión de analíticas | Extienda el comportamiento relacionado con analíticas donde esté soportado | Puntos de extensión de analíticas |
| Puntos de extensión de Market Insights | Revise los límites de extensión para lógica relacionada con el mercado | Puntos de extensión de Market Insights |
| Puntos de extensión del gestor de PDF | Extienda o personalice los flujos de trabajo relacionados con PDF donde esté soportado | Puntos de extensión del gestor de PDF |
API, AJAX y procesamiento en segundo plano
Los desarrolladores deben revisar el comportamiento de endpoints, acciones AJAX y hooks de cron antes de extender flujos de trabajo técnicos.
API REST
Revise el comportamiento de endpoints de API REST, gestión de solicitudes, contexto de autenticación y patrones de respuesta.
API REST para desarrolladores Endpoints de API RESTAcciones AJAX
Revise las acciones AJAX de WordPress, verificaciones de nonce, verificaciones de capacidad, validación de entrada y gestión de respuestas.
Acciones AJAX para desarrolladores Acciones AJAXHooks de cron
Revise el procesamiento programado, las tareas recurrentes y los hooks en segundo plano utilizados por las importaciones, la limpieza y la automatización.
Hooks de cron para desarrolladores Eventos cron y programadorPlantillas y recursos del frontend
La personalización del frontend debe usar el sistema de plantillas documentado, el comportamiento de shortcodes y la estructura de recursos.
Sistema de plantillas
- Sobrescrituras de plantillas
- Salida del archivo
- Salida del detalle del vehículo
- Shortcodes
- Módulos del frontend
- Compatibilidad con el tema
Recursos y comportamiento de la UI
- Recursos del frontend
- Recursos de administración
- Comportamiento responsive
- Integración con constructores de páginas
- CSS personalizado
- Restricciones de la interfaz de administración
Seguridad, saneamiento y verificaciones de capacidad
El trabajo de los desarrolladores debe seguir las prácticas de seguridad de WordPress y evitar exponer datos privados u operaciones inseguras.
Prácticas requeridas
- Use verificaciones de capacidad para acciones privilegiadas
- Valide los nonces para acciones AJAX y de formularios
- Sanee los datos entrantes
- Escape la salida
- Evite exponer credenciales
- No registre valores sensibles
- Use consultas de base de datos preparadas
- Respete la configuración de privacidad y conservación
Depuración, pruebas y flujo de lanzamiento
Antes de desplegar cambios, los desarrolladores deben revisar la documentación de registro, depuración, pruebas y flujo de lanzamiento.
- Depurar localmente Use orientación de desarrollo local y registro para reproducir problemas antes de cambiar el comportamiento de producción.
- Validar el comportamiento Pruebe los flujos de importación, las respuestas de la API, los hooks de cron, la salida del frontend y las pantallas de administración después de los cambios.
- Revisar seguridad Compruebe el saneamiento, escape, capacidades y exposición de datos públicos antes del lanzamiento.
- Preparar lanzamiento Siga la orientación de lanzamiento, compilación y contribución antes de empaquetar o desplegar cambios.
Reglas de documentación pública para desarrolladores
La documentación para desarrolladores debe ser útil para los socios de implementación sin exponer detalles de implementación privados.
Seguro para publicar
- Visiones generales de arquitectura
- Hooks y filtros públicos
- Comportamiento general de endpoints
- Orientación de sobrescritura de plantillas
- Estándares de código
- Flujo de trabajo de pruebas
- Orientación de resolución de problemas
- Proceso de lanzamiento
- Puntos de extensión generales
No publique
- Secretos de API
- Tokens de acceso privados
- Rutas internas del servidor
- Datos del cliente
- URLs de API privadas
- Credenciales sin procesar
- Detalles de exploits sensibles a la seguridad
- Notas de implementación confidenciales
- Notas internas de riesgo
Documentación para desarrolladores
Abra los documentos relevantes para desarrolladores directamente en el repositorio de documentación pública.
Primeros pasos para desarrolladores
- Sección de documentación para desarrolladores
- Visión general para desarrolladores
- Configuración de desarrollo local
- Estructura del repositorio
- Estándares de código
Arquitectura y almacenamiento
- Arquitectura del plugin para desarrolladores
- Tablas de base de datos para desarrolladores
- Claves de opciones y almacenamiento de configuración
- Tipos de entrada personalizados y taxonomías
Puntos de extensión
- Hooks y filtros
- Referencia de acciones
- Referencia de filtros
- Puntos de extensión del motor de importación
- Puntos de extensión de importación de imágenes
- Puntos de extensión del procesamiento de leads
- Puntos de extensión de analíticas
- Puntos de extensión de Market Insights
- Puntos de extensión del gestor de PDF
API y procesamiento en segundo plano
- API REST para desarrolladores
- Acciones AJAX para desarrolladores
- Hooks de cron para desarrolladores
- Endpoints de API REST
- Acciones AJAX
- Webhooks
Seguridad, depuración y lanzamiento
- Verificaciones de seguridad y capacidad
- Saneamiento y escape
- Registro y depuración
- Guía de pruebas
- Proceso de lanzamiento y compilación
- Directrices de contribución
Los enlaces de documentación siguen el idioma activo del sitio web. El inglés es el idioma de origen. Las carpetas de otros idiomas usan nombres de carpetas y archivos localizados.