Remote Requests med wp_remote_get
Om du har läst något av mina tidigare inlägg om att hämta fjärrfiler, då vet du att gamla vanor dör hårt eftersom jag ofta använder file_get_contentssnarare än wp_remote_get.
Så, som man gör när man bloggar, tänkte jag att det skulle vara bra att dela med sig av ett enkelt exempel på hur man använder wp_remote_getdet i ditt dagliga arbete.
Inlägget nedan är bara ett utdrag av hur man använder det. Det vill säga, det kommer inte att visa hur man designar, säg, en klass runt den eller ett användargränssnitt som tillåter användare att ladda upp en fil. Men det här borde räcka för att få igång saker och ting.
Och jag kommer att inkludera hur man tar API-dokumentationen runt den och förstår hur man använder den när man använder en funktion som denna.
Varför använda wp_remote_get?
Även om jag inte alltid använder WordPress API (vilket vanligtvis beror på att gamla vanor försvinner eller för att jag inte är medveten om en funktion), försöker jag.
Och jag är övertygad om att om du arbetar i en applikations speciella miljö och nämnda applikation tillhandahåller ett API för något, så bör du använda det.
Hur man läser dokumenten
Om du är bekant med hur du använder dokumentation kan du hoppa över det här avsnittet.
Med det sagt, här är vad dokumentationen runt wp_remote_getsäger:
Hämta råsvaret från HTTP-förfrågan med GET- metoden. Resultaten inkluderar HTTP-rubriker och innehåll.
Du kan läsa mer på både den här sidan i Codex och den här sidan i utvecklarresurserna. Men innan du faktiskt använder funktionen är det viktigt att förstå vad den accepterar och vad den returnerar.
Och funktionen accepterar två parametrar:
- URL:en som begäran görs till,
- uppsättningen argument som krävs för begäran (vilket ligger utanför ramen för detta inlägg).
Och wp_remote_get returnerar blandade resultat baserat på resultatet av begäran. Enligt utvecklarresurserna:
(WP_Error|array) Svaret eller WP_Error vid fel.
Vid det här laget vet vi vad funktionen gör, vad den accepterar och vad den returnerar. Så vi har nog att gå på när det gäller att sätta upp ett enkelt exempel.
Använder wp_remote_get
Med allt ovan på plats, här är ett enkelt exempel på hur man hämtar en fil från en given URL. Jag antar att URL:en finns på din lokala server (eftersom jag inte vill gå in på att begära information från andra servrar i det här inlägget) vilket är anledningen till att domänen är dot-locals toppdomän.
Kommentarerna bör förklara vad som händer, men jag kommer att ge några fler tankar efter det.
Det viktigaste att notera är följande:
- Kontrollera rubrikerna för att se till att de är inställda. Om inte, så finns det ingen anledning att fortsätta med att ta tag i filens kropp.
- Om det finns ett fel måste vi hantera det på ett elegant sätt.
- Om allt annat checkar ut är vi redo att skriva filen till disken. Jag använder PHPs filfunktioner för att göra detta. Det ligger lite utanför inläggets ram men borde vara lätt att förstå om du studerar länkarna nedan.
I slutändan ger användningen wp_remote_getdig en hel del funktionalitet insvept i en lättanvänd funktion.