Come aggiungere un endpoint alle REST API di WordPress

WordPress fornisce un'API REST potente e flessibile che consente agli sviluppatori di interagire con il sito web in modo programmatico. In questo articolo, vedremo come aggiungere un endpoint personalizzato alle REST API di WordPress.

Puoi aggiungere il tuo endpoint personalizzato nel file functions.php del tuo tema oppure, preferibilmente, creare un plugin dedicato per mantenere il codice organizzato.

Utilizzo della Funzione register_rest_route()

WordPress consente di registrare nuovi endpoint utilizzando la funzione register_rest_route(), che va agganciata all'azione rest_api_init. Ecco un esempio:


function my_custom_api_endpoint() {
    register_rest_route('myplugin/v1', '/data/', [
        'methods'  => 'GET',
        'callback' => 'my_custom_api_callback',
        'permission_callback' => '__return_true',
    ]);
}
add_action('rest_api_init', 'my_custom_api_endpoint');

In questo codice, registriamo un endpoint /wp-json/myplugin/v1/data/ che risponde alle richieste GET.

Creazione della Funzione di Callback

La funzione di callback deve restituire i dati desiderati in formato JSON:


function my_custom_api_callback($request) {
    $data = [
        'message' => 'Ciao, questo è il mio endpoint personalizzato!',
        'timestamp' => time()
    ];
    return rest_ensure_response($data);
}

Test dell’Endpoint

Ora puoi testare l'endpoint visitando l'URL nel browser o utilizzando strumenti come Postman:


https://example.com/wp-json/myplugin/v1/data/

Se tutto è stato configurato correttamente, otterrai una risposta JSON simile a questa:


{
    "message": "Ciao, questo è il mio endpoint personalizzato!",
    "timestamp": 1700000000
}

Conclusione

Aggiungere un endpoint personalizzato alle REST API di WordPress è un processo semplice e potente per estendere le funzionalità del tuo sito. Puoi usare questa tecnica per fornire dati personalizzati ad applicazioni esterne o migliorare l’interazione del tuo sito con altri servizi.

Torna su