DOCUMENTAZIONE PER SVILUPPATORI

Note tecniche per sviluppatori sull'integrazione di ADP Car Market Hub

Esplorate la documentazione pubblica per sviluppatori di ADP Car Market Hub, comprendente architettura, hook, filtri, riferimenti API REST, azioni AJAX, hook cron, template override, linee guida di sicurezza, debug e flusso di rilascio.

Apri la documentazione per sviluppatori Apri Hook e filtri

Panoramica della documentazione per sviluppatori

La documentazione per sviluppatori offre agli implementatori tecnici un punto di ingresso strutturato all'architettura del plugin, ai punti di estensione, al comportamento degli endpoint e ai flussi di personalizzazione sicura.

Punti di estensione

Utilizzate azioni, filtri, hook e punti di estensione documentati invece di modificare i file core del plugin.

Hook e filtri

API ed elaborazione in background

Esaminate il comportamento dell'API REST, le azioni AJAX, gli hook cron e i confini dell'elaborazione pianificata.

API REST per sviluppatori

Template e asset frontend

Utilizzate template override, asset frontend e comportamento degli shortcode per personalizzare l'output in modo sicuro.

Sistema di template e override

Flusso di sicurezza e di rilascio

Seguite le linee guida su controlli di capability, sanitizzazione, escape, test e rilascio prima di distribuire modifiche.

Sicurezza e controlli di capability

Punti di ingresso per sviluppatori

Iniziate dai documenti adatti al vostro ruolo e al compito di implementazione.

Onboarding per nuovi sviluppatori Per iniziare
Panoramica per sviluppatori Configurazione dell'ambiente di sviluppo locale Struttura del repository Standard di codifica
Architettura del plugin Architettura
Architettura del plugin per sviluppatori Tabelle del database per sviluppatori Chiavi di opzione e archiviazione delle impostazioni Custom post type e tassonomie
Sviluppo di estensioni Punti di estensione
Hook e filtri Riferimento delle azioni Riferimento dei filtri Punti di estensione del motore di importazione
Personalizzazione del frontend Frontend
Sistema di template e override Asset frontend Asset di amministrazione Shortcode per sviluppatori

Architettura e orientamento nella codebase

Prima di aggiungere integrazioni o personalizzazioni, gli sviluppatori dovrebbero comprendere ciclo di vita, struttura del repository, modello dati e comportamento di archiviazione del plugin.

Argomenti chiave dell'architettura

  • Ciclo di vita del plugin
  • Struttura del repository
  • Modello dati
  • Tabelle del database
  • Archiviazione di opzioni e impostazioni
  • Custom post type e tassonomie
  • Motore di importazione
  • Coda di importazione immagini
  • Scheduler cron

Ordine di lettura consigliato

Apri la panoramica per sviluppatori Apri l'architettura del plugin Apri il modello dati

Punti di estensione

Le integrazioni personalizzate devono utilizzare i punti di estensione documentati invece di modificare i file core del plugin.

Area di estensione Caso d'uso Documento consigliato
Azioni Reagire a eventi del plugin o a passaggi di elaborazione Riferimento delle azioni
Filtri Modificare valori o output tramite punti di filtro controllati Riferimento dei filtri
Panoramica di hook e filtri Comprendere i meccanismi di estensione disponibili Hook e filtri
Punti di estensione del motore di importazione Estendere o adattare in modo sicuro il comportamento legato alle importazioni Punti di estensione del motore di importazione
Punti di estensione dell'importazione immagini Personalizzare la gestione delle immagini o il comportamento della coda dove supportato Punti di estensione dell'importazione immagini
Punti di estensione dell'elaborazione lead Integrare la gestione dei lead con flussi esterni Punti di estensione dell'elaborazione lead
Punti di estensione degli analytics Estendere il comportamento legato agli analytics dove supportato Punti di estensione degli analytics
Punti di estensione di Market Insights Esaminare i confini di estensione per la logica legata al mercato Punti di estensione di Market Insights
Punti di estensione del PDF manager Estendere o personalizzare i flussi PDF dove supportato Punti di estensione del PDF manager

API, AJAX ed elaborazione in background

Gli sviluppatori dovrebbero esaminare comportamento degli endpoint, azioni AJAX e hook cron prima di estendere i flussi tecnici.

Template e asset frontend

La personalizzazione del frontend deve utilizzare il sistema di template, il comportamento degli shortcode e la struttura degli asset documentati.

Sistema di template

  • Override dei template
  • Output dell'archivio
  • Output del dettaglio veicolo
  • Shortcode
  • Moduli frontend
  • Compatibilità con i temi
Sistema di template e override Override dei template Shortcode per sviluppatori Guida al frontend

Asset e comportamento dell'interfaccia

  • Asset frontend
  • Asset di amministrazione
  • Comportamento responsive
  • Integrazione con i page builder
  • CSS personalizzato
  • Vincoli dell'interfaccia di amministrazione
Asset frontend Asset di amministrazione Guida al CSS personalizzato Integrazione con i page builder

Sicurezza, sanitizzazione e controlli di capability

Il lavoro degli sviluppatori deve seguire le pratiche di sicurezza di WordPress ed evitare di esporre dati privati o operazioni non sicure.

Pratiche richieste

  • Utilizzare controlli di capability per le azioni privilegiate
  • Validare i nonce per le azioni AJAX e dei form
  • Sanitizzare i dati in ingresso
  • Effettuare l'escape dell'output
  • Evitare di esporre credenziali
  • Non registrare valori sensibili nei log
  • Utilizzare query preparate per il database
  • Rispettare le impostazioni di privacy e conservazione

Riferimenti per sviluppatori

Sicurezza e controlli di capability Sanitizzazione ed escape Controllo degli accessi e capability Privacy, sicurezza e conformità Limitazioni note e rischi aperti

Debug, test e flusso di rilascio

Prima di distribuire modifiche, gli sviluppatori dovrebbero esaminare la documentazione su logging, debug, test e flusso di rilascio.

  1. Eseguire il debug in locale Utilizzate le indicazioni su sviluppo locale e logging per riprodurre i problemi prima di modificare il comportamento in produzione.
    Configurazione dell'ambiente di sviluppo locale Logging e debug
  2. Validare il comportamento Testate flussi di importazione, risposte API, hook cron, output frontend e schermate di amministrazione dopo le modifiche.
    Guida ai test Punti di estensione del motore di importazione
  3. Verificare la sicurezza Verificate sanitizzazione, escape, capability ed esposizione di dati pubblici prima del rilascio.
    Sicurezza e controlli di capability Sanitizzazione ed escape
  4. Preparare il rilascio Seguite le linee guida di rilascio, build e contribuzione prima di pacchettizzare o distribuire le modifiche.
    Processo di rilascio e build Linee guida di contribuzione

Regole per la documentazione pubblica destinata agli sviluppatori

La documentazione per sviluppatori deve essere utile per i partner di implementazione senza esporre dettagli implementativi privati.

Pubblicabile in sicurezza

  • Panoramiche di architettura
  • Hook e filtri pubblici
  • Comportamento generale degli endpoint
  • Linee guida per gli override dei template
  • Standard di codifica
  • Flusso di test
  • Linee guida di troubleshooting
  • Processo di rilascio
  • Punti di estensione generali

Non pubblicare

  • Segreti API
  • Token di accesso privati
  • Percorsi server interni
  • Dati dei clienti
  • URL API privati
  • Credenziali grezze
  • Dettagli su exploit sensibili dal punto di vista della sicurezza
  • Note implementative riservate
  • Note interne sui rischi

Documentazione per sviluppatori

Aprite direttamente i documenti per sviluppatori pertinenti nel repository pubblico della documentazione.

Primi passi per sviluppatori

Architettura e archiviazione

Punti di estensione

API ed elaborazione in background

Sicurezza, debug e rilascio

I link della documentazione seguono la lingua attiva del sito. L'inglese è la lingua sorgente. Le altre cartelle di lingua utilizzano nomi di cartella e file localizzati.

Continua a esplorare

Apri API e webhook Apri la guida di integrazione Apri i requisiti di sistema