Questo post mostrer\u00e0 come creare endpoint REST WordPress personalizzati e diversi metodi per eseguire le richieste. Ci saranno esempi in PHP, jQuery e vanilla Javascript.<\/p>\n
Presumo che tu abbia gi\u00e0 familiarit\u00e0 con cos’\u00e8 l’API REST di WP, ma ecco un breve riassunto. L’API REST di WordPress \u00e8 un’interfaccia JSON per inviare e ricevere dati dal tuo sito WordPress. \u00c8 possibile accedere agli endpoint (percorsi\/URL specifici) sia esternamente che internamente. WordPress ha gi\u00e0 un sacco di endpoint disponibili, ad esempio per recuperare post, categorie, cercare nel sito e altro ancora. Vedi una panoramica degli endpoint WordPress predefiniti<\/a> qui. Ma gli sviluppatori sono completamente liberi di creare i propri endpoint personalizzati utilizzando questa API, per eseguire azioni o recuperare dati.<\/p>\n Inizieremo con il primo passaggio; che sta creando endpoint personalizzati. Se sei interessato solo a come fare richieste, passa alla seconda parte.<\/p>\n La registrazione di endpoint personalizzati viene eseguita in PHP. Puoi aggiungere il codice al Come primo parametro Come terzo parametro dovresti fornire gli argomenti ‘method’ e ‘callback’ (che \u00e8 la funzione per gestire i dati dell’endpoint). Per ‘metodo’ puoi impostarli come ‘ Creiamo un endpoint personalizzato di base che pu\u00f2 essere raggiunto utilizzando le richieste GET:<\/p>\n Alla riga Quando registri (o modifichi) i percorsi dell’API REST utilizzando Non abbiamo ancora definito la funzione di callback, che \u00e8 la funzione per il codice che gestisce la reazione dell’utilizzo di questo endpoint. Deve restituire una risposta valida REST (in JSON), quindi dovrai restituire qualcosa anche se l’endpoint non dovrebbe restituire dati. \u00c8 possibile utilizzare la funzione Questo \u00e8 il modo pi\u00f9 semplice per scrivere una richiamata. La funzione Con il codice sopra (registrazione dell’endpoint e della funzione di callback) puoi provare ad andare all’URL nel tuo browser e vedere cosa ottieni. (Ricordati di svuotare i tuoi permalink). Andando su \u00c8 molto comune e utile consentire agli endpoint di accettare parametri. Ad esempio, se il tuo sito ha dati di prodotto, ad esempio, vorresti un endpoint in cui puoi fornire un ID prodotto per ottenere i dati di quel prodotto. Ci sono due modi per farlo. Il modo pi\u00f9 comune consiste nell’usare la stringa di query GET (che viene aggiunta dopo l’URL dopo un Definire possibili parametri GET per il tuo endpoint sta usando la Ad esempio, vogliamo consentire al nostro endpoint di accettare ‘ Se definisci un parametro come true in Alla riga Con il codice sopra, ricever\u00f2 "Hello there!" quando visito Se si desidera consentire ai parametri di far parte del percorso anzich\u00e9 GET stringa di query, \u00e8 possibile farlo. Fornirai quindi un modello regex nel percorso, il secondo parametro per La creazione di modelli regex pu\u00f2 sembrare piuttosto criptica, ma poich\u00e9 \u00e8 un argomento intero, troverai facilmente esempi per casi specifici se lo cerchi su Google. Mostrer\u00f2 un esempio di definizione di una regex che accetta un numero di qualsiasi lunghezza;<\/p>\n Come puoi vedere nella riga n. 2, ho aggiunto il pattern regex Crea endpoint personalizzati<\/h2>\n
functions.php<\/code>file di codice del tuo tema o di un plug-in attivo. Crea una funzione agganciata rest_api_init<\/code>e usa la funzione [register_rest_route](https:\/\/developer.wordpress.org\/reference\/functions\/register_rest_route\/)()<\/code>per ogni endpoint che desideri aggiungere.<\/p>\nregister_rest_route()<\/code>devi fornire uno spazio dei nomi univoco per assicurarti che i tuoi endpoint non siano in conflitto con altri. Usa lo slug del tuo tema o del plugin. \u00c8 pratica comune quindi includere un \/<\/code>seguito da un numero di versione per il codice. Come esempio user\u00f2 lo spazio dei nomi awhitepixel\/v1<\/code>. Il secondo parametro \u00e8 il percorso (che segue lo spazio dei nomi). Infine puoi opzionalmente fornire un array come terzo parametro con opzioni. In questo array puoi ad esempio definire il metodo di richiesta (GET, POST o qualsiasi altro), definire i parametri e, soprattutto, definire la funzione da eseguire quando viene richiesto quell’endpoint.<\/p>\nGET'<\/code>, 'POST'<\/code>, 'PUT'<\/code>, o qualsiasi altro metodo di richiesta valido (o un array di multipli), ma per questo consiglio di utilizzare le impostazioni predefinite di WordPress. Sono i seguenti:<\/p>\n\n
WP_REST_Server::READABLE<\/code> metodo ‘ GET<\/code>‘<\/li>\nWP_REST_Server::EDITABLE<\/code> metodi ‘ POST<\/code>‘, ‘ PUT<\/code>‘ e ‘ PATCH<\/code>‘<\/li>\nWP_REST_Server::DELETABLE<\/code> metodo ‘ DELETE<\/code>‘<\/li>\nWP_REST_Server::ALLMETHODS<\/code> tutti i metodi di cui sopra<\/li>\n<\/ul>\nadd_action( 'rest_api_init', function() {\n register_rest_route( 'awhitepixel\/v1', '\/getsomedata', [\n 'method' => WP_REST_Server::READABLE,\n 'callback' => 'awhitepixel_rest_route_getsomedata',\n ] );\n} );<\/code><\/pre>\n#2<\/code>abbiamo definito il nostro endpoint personalizzato come ‘ awhitepixel\/v1\/getsomedata<\/code>‘. L’URL completo sarebbe l’URL radice dell’API REST di WordPress con prefisso, ovvero <yourdomain>\/wp-json<\/code>. Quindi l’URL completo dell’endpoint sopra sarebbe " <yourdomain>\/wp-json\/awhitepixel\/v1\/getsomedata<\/code>". Alla riga #4<\/code>abbiamo fornito un nome di funzione come callback, che aggiungeremo a breve.<\/p>\nregister_rest_route()<\/code>, dovrai svuotare i tuoi permalink<\/strong> affinch\u00e9 funzionino. Puoi farlo visitando Impostazioni> Permalink in amministratore e fai semplicemente clic su Salva.<\/p>\n[rest_ensure_response](https:\/\/developer.wordpress.org\/reference\/functions\/rest_ensure_response\/)()<\/code>funzione o creare un’istanza di WP_REST_Response<\/code>oggetto come ritorno del callback. Come parametro della funzione di callback otteniamo un WP_REST_Request<\/code>oggetto che contiene tutte le informazioni sulla richiesta, inclusi eventuali parametri. Creiamo una semplice funzione di callback che invia semplicemente del testo come risposta:<\/p>\nfunction awhitepixel_rest_route_getsomedata( $request) {\n $response = 'Hello there!';\n return rest_ensure_response( $response );\n}<\/code><\/pre>\nrest_ensure_response()<\/code>assicura che tutti i dati forniti (la stringa) vengano convertiti in una risposta valida REST. Ovviamente vorrai aggiungere pi\u00f9 codice qui, per fare qualcosa in WordPress o recuperare e inviare i dati.<\/p>\n<domain>\/wp-json\/awhitepixel\/v1\/getsomedata<\/code>nel browser verr\u00e0 mostrata la stringa "Hello there!".<\/p>\nAccettazione dei parametri<\/h3>\n
?<\/code>, separata da &<\/code>nel formato chiave=valore. Ad esempio ‘ <endpoint>\/product\/?product_id=14<\/code>‘). In alternativa puoi definire un pattern URL "pi\u00f9 carino", in cui i parametri fanno parte del percorso. Ad esempio " <endpoint>\/product\/14\/<\/code>". Tuttavia, quest’ultimo metodo richiede alcune conoscenze per le espressioni regolari. Quale metodo sceglierai dipende da te, di seguito dimostrer\u00f2 entrambi.<\/p>\nOTTIENI i parametri<\/h4>\n
args<\/code>chiave ‘ ‘ nel register_rest_route()<\/code>terzo parametro di ‘. Per ogni parametro che vuoi consentire, definisci il valore della chiave (nell’esempio sopra ‘ product_id<\/code>‘) e una matrice di opzioni per quel parametro. Come opzioni puoi definire il formato del parametro (se prevede ad esempio un numero o una stringa) e anche decidere se quel parametro \u00e8 obbligatorio o meno.<\/p>\nproduct_id<\/code>‘ come numero non richiesto.<\/p>\nadd_action( 'rest_api_init', function() {\n register_rest_route( 'awhitepixel\/v1', '\/getsomedata', [\n 'method' => WP_REST_Server::READABLE,\n 'callback' => 'awhitepixel_rest_route_getsomedata',\n 'args' => [\n 'product_id' => [\n 'required' => false,\n 'type' => 'number',\n ],\n ],\n ] );\n} );\n\u00a0\nfunction awhitepixel_rest_route_getsomedata( $request) {\n $product_id = $request->get_param( 'product_id' );\n if (! empty( $product_id)) {\n $response = 'Return product data for ID '. $product_id;\n } else {\n $response = 'Hello there!';\n }\n return rest_ensure_response( $response );\n}<\/code><\/pre>\nrequired<\/code>, WordPress gestir\u00e0 il passaggio di una risposta di errore 400. Allo stesso modo se si passa un formato non valido, ad esempio "ciao" come valore a un parametro che si aspetta un numero.<\/p>\n#15<\/code>nella funzione di callback si vede come ottenere il valore del parametro dalla richiesta; utilizzando il metodo nell’oggetto get_param()<\/code>passato. WP_REST_Request<\/code>A titolo di esempio mostrer\u00f2 risposte diverse a seconda che siano product_id<\/code>state fornite o meno (ricordiamo che l’abbiamo definita opzionale). La logica di modificare il tuo codice in base ai parametri forniti dipende completamente da te e dal tuo progetto. Puoi avere meno endpoint che accettano molti parametri o molti pi\u00f9 endpoint separati per ogni caso specifico.<\/p>\n<yourdomain>\/awhitepixel\/v1\/getsomedata<\/code>e "Restituisci i dati del prodotto per l’ID 14" quando vado a <yourdomain>\/awhitepixel\/v1\/getsomedata\/?product_id=14<\/code>.<\/p>\nParametri come parte del percorso<\/h4>\n
register_rest_route()<\/code>.<\/p>\nadd_action( 'rest_api_init', function() {\n register_rest_route( 'awhitepixel\/v1', '\/getsomedata\/(?P<product_id>[d]+)', [\n 'method' => WP_REST_Server::READABLE,\n 'callback' => 'awhitepixel_rest_route_getsomedata',\n ] );\n} );\n\u00a0\nfunction awhitepixel_rest_route_getsomedata( $request) {\n $product_id = $request->get_param( 'product_id' );\n $response = 'Return product data for ID '. $product_id;\n return rest_ensure_response( $response );\n}<\/code><\/pre>\n(?P<product_id>[d]+)<\/code>alla fine. Questo pattern significa che dobbiamo raccogliere un numero( d<\/code>) di qualsiasi lunghezza( +<\/code>) e assegnare il valore raccolto nella chiave del parametro product_id<\/code>. E nella nostra funzione di callback utilizziamo esattamente lo stesso metodo utilizzato durante l’impostazione dei parametri GET; get_param()<\/code>nell’oggetto WP_REST_Request<\/code>fornito alla funzione.<\/p>\n