Requêtes à distance avec wp_remote_get
Si vous avez lu l’un de mes articles précédents sur la récupération de fichiers distants, alors vous savez que les vieilles habitudes ont la vie dure car j’utilise souvent file_get_contentsplutôt que wp_remote_get.
Donc, comme on le fait quand on blogue, j’ai pensé qu’il serait utile de partager un exemple simple d’utilisation wp_remote_getdans votre travail quotidien.
Le message ci-dessous n’est qu’un extrait de la façon de l’utiliser. Autrement dit, il ne montrera pas comment concevoir, par exemple, une classe autour d’elle ou une interface utilisateur permettant aux utilisateurs de télécharger un fichier. Mais cela devrait suffire à démarrer les choses.
Et j’inclurai comment utiliser la documentation de l’API et comprendre comment l’exploiter lors de l’utilisation d’une fonction comme celle-ci.
Pourquoi utiliser wp_remote_get ?
Bien que je n’utilise pas toujours l’API WordPress (ce qui est généralement dû, encore une fois, à de vieilles habitudes ou à l’ignorance d’une fonction), j’essaie.
Et je crois fermement que si vous travaillez dans l’environnement particulier d’une application et que ladite application fournit une API pour quelque chose, alors vous devriez l’utiliser.
Comment lire les documents
Si vous savez comment tirer parti de la documentation, vous pouvez ignorer cette section.
Cela dit, voici ce que dit la documentation wp_remote_get:
Récupérez la réponse brute de la requête HTTP à l’aide de la méthode GET. Les résultats incluent les en-têtes et le contenu HTTP.
Vous pouvez en savoir plus à la fois sur cette page du Codex et sur cette page des Ressources pour les développeurs. Mais avant d’utiliser réellement la fonction, il est important de comprendre ce qu’elle accepte et ce qu’elle renvoie.
Et la fonction accepte deux paramètres :
- l’URL vers laquelle la demande est faite,
- l’ensemble des arguments requis pour la requête (ce qui sort du cadre de cet article).
Et wp_remote_get renvoie des résultats mitigés en fonction du résultat de la requête. Selon les ressources pour développeurs :
(WP_Error|array) La réponse ou WP_Error en cas d’échec.
À ce stade, nous savons ce que fait la fonction, ce qu’elle accepte et ce qu’elle renvoie. Nous avons donc suffisamment de choses à faire concernant la mise en place d’un exemple simple.
Utilisation de wp_remote_get
Avec tout ce qui précède en place, voici un exemple simple de la façon de récupérer un fichier à partir d’une URL donnée. Je suppose que l’URL se trouve sur votre serveur local (parce que je ne veux pas demander d’informations à d’autres serveurs dans ce message), c’est pourquoi le domaine est le TLD de point-local.
Les commentaires devraient expliquer ce qui se passe, mais je proposerai quelques réflexions supplémentaires après cela.
Les remarques les plus importantes sont les suivantes :
- Vérifiez les en-têtes pour vous assurer qu’ils sont définis. Si ce n’est pas le cas, il n’est pas nécessaire de saisir le corps du fichier.
- S’il y a une erreur, nous devons la gérer avec élégance.
- Si tout le reste est vérifié, nous sommes prêts à écrire le fichier sur le disque. J’utilise les fonctions de fichier de PHP pour ce faire. C’est un peu en dehors de la portée de l’article, mais cela devrait être facile à comprendre si vous étudiez les liens ci-dessous.
En fin de compte, l’utilisation wp_remote_getvous offre de nombreuses fonctionnalités intégrées dans une fonction facile à utiliser.