Cet article montrera comment cr\u00e9er des points de terminaison WordPress REST personnalis\u00e9s et diff\u00e9rentes m\u00e9thodes pour leur envoyer des requ\u00eates. Il y aura des exemples en PHP, jQuery et Javascript vanille.<\/p>\n
Je suppose que vous connaissez d\u00e9j\u00e0 l’API WP REST, mais voici un bref r\u00e9sum\u00e9. WordPress REST API est une interface JSON pour envoyer et recevoir des donn\u00e9es de votre site WordPress. Vous pouvez acc\u00e9der aux points de terminaison (chemins\/URL sp\u00e9cifiques) \u00e0 la fois en externe et en interne. WordPress a d\u00e9j\u00e0 un tas de points de terminaison disponibles, par exemple pour r\u00e9cup\u00e9rer des publications, des cat\u00e9gories, rechercher sur le site et plus encore. Voir un aper\u00e7u des points de terminaison WordPress par d\u00e9faut<\/a> ici. Mais les d\u00e9veloppeurs sont enti\u00e8rement libres de cr\u00e9er leurs propres points de terminaison personnalis\u00e9s \u00e0 l’aide de cette API, pour effectuer des actions ou r\u00e9cup\u00e9rer des donn\u00e9es.<\/p>\n Nous allons commencer par la premi\u00e8re \u00e9tape\u00a0; qui cr\u00e9e des points de terminaison personnalis\u00e9s. Si vous \u00eates seulement int\u00e9ress\u00e9 par la fa\u00e7on de faire des demandes, passez directement \u00e0 la deuxi\u00e8me partie.<\/p>\n L’enregistrement des points de terminaison personnalis\u00e9s se fait en PHP. Vous pouvez ajouter le code au fichier de code de votre th\u00e8me En tant que premier param\u00e8tre, Au minimum, vous devez fournir les arguments ‘method’ et ‘callback’ (qui est la fonction pour g\u00e9rer les donn\u00e9es du point de terminaison) comme troisi\u00e8me param\u00e8tre. Pour ‘m\u00e9thode’, vous pouvez les d\u00e9finir comme ‘ Cr\u00e9ons un point de terminaison personnalis\u00e9 de base qui peut \u00eatre atteint \u00e0 l’aide de requ\u00eates GET\u00a0:<\/p>\n \u00c0 la ligne, Lors de l’enregistrement (ou de la modification) des routes de l’API REST \u00e0 l’aide Nous n’avons pas encore d\u00e9fini la fonction de rappel – qui est la fonction du code qui g\u00e8re la r\u00e9action de l’utilisation de ce point de terminaison. Il doit renvoyer une r\u00e9ponse valide REST (en JSON), vous devrez donc renvoyer quelque chose m\u00eame si le point de terminaison n’est pas cens\u00e9 renvoyer de donn\u00e9es. Vous pouvez utiliser la fonction C’est la mani\u00e8re la plus basique d’\u00e9crire un callback. La fonction Avec le code ci-dessus (enregistrement du point de terminaison et de la fonction de rappel), vous pouvez essayer d’acc\u00e9der \u00e0 l’URL de votre navigateur et voir ce que vous obtenez. (Pensez \u00e0 vider vos permaliens). Aller \u00e0 Il est tr\u00e8s courant et utile d’autoriser les points de terminaison \u00e0 accepter des param\u00e8tres. Par exemple, si votre site contient par exemple des donn\u00e9es sur les produits, vous voudriez un point de terminaison o\u00f9 vous pouvez fournir un ID de produit afin d’obtenir les donn\u00e9es de ce produit. Il y a deux fa\u00e7ons de proc\u00e9der. La m\u00e9thode la plus courante consiste \u00e0 utiliser la cha\u00eene de requ\u00eate GET (qui est ajout\u00e9e apr\u00e8s l’URL apr\u00e8s un La d\u00e9finition des param\u00e8tres GET possibles sur votre point de terminaison utilise la Par exemple, nous voulons permettre \u00e0 notre point de terminaison d’accepter ‘ Si vous d\u00e9finissez un param\u00e8tre comme vrai dans \u00c0 la ligne Avec le code ci-dessus, j’obtiendrai "Hello there!" lorsque je visite Si vous souhaitez autoriser les param\u00e8tres \u00e0 faire partie du chemin plut\u00f4t que la cha\u00eene de requ\u00eate GET, vous pouvez le faire. Vous fournirez ensuite un mod\u00e8le regex dans le chemin – le deuxi\u00e8me param\u00e8tre de La cr\u00e9ation de mod\u00e8les regex peut sembler assez \u00e9nigmatique, mais comme il s’agit d’un sujet complet, vous trouverez facilement des exemples pour des cas sp\u00e9cifiques si vous le recherchez sur Google. Je vais montrer un exemple de d\u00e9finition d’une expression r\u00e9guli\u00e8re qui accepte un nombre de n’importe quelle longueur\u00a0;<\/p>\n Comme vous pouvez le voir \u00e0 la ligne 2, j’ai ajout\u00e9 le motif regex Cr\u00e9er des points de terminaison personnalis\u00e9s<\/h2>\n
functions.php<\/code>ou d’un plugin actif. Cr\u00e9ez une fonction accroch\u00e9e \u00e0 rest_api_init<\/code>et utilisez la fonction [register_rest_route](https:\/\/developer.wordpress.org\/reference\/functions\/register_rest_route\/)()<\/code>pour chaque point de terminaison que vous souhaitez ajouter.<\/p>\nregister_rest_route()<\/code>vous devez fournir un espace de noms unique pour vous assurer que vos points de terminaison n’entrent pas en conflit avec les autres. Utilisez le slug de votre th\u00e8me ou plugin. Il est courant d’inclure ensuite un \/<\/code>suivi d’un num\u00e9ro de version pour votre code. \u00c0 titre d’exemple, j’utiliserai l’espace de noms awhitepixel\/v1<\/code>. Le deuxi\u00e8me param\u00e8tre est le chemin (qui suit l’espace de noms). Enfin, vous pouvez \u00e9ventuellement fournir un tableau comme troisi\u00e8me param\u00e8tre avec des options. Dans ce tableau, vous pouvez par exemple d\u00e9finir la m\u00e9thode de requ\u00eate (GET, POST ou toute autre), d\u00e9finir des param\u00e8tres et, surtout, d\u00e9finir la fonction \u00e0 ex\u00e9cuter lorsque ce point de terminaison est demand\u00e9.<\/p>\nGET'<\/code>, 'POST'<\/code>, 'PUT'<\/code>, ou toute autre m\u00e9thode de requ\u00eate valide (ou un tableau de plusieurs), mais je recommande d’utiliser les valeurs par d\u00e9faut de WordPress pour cela. Ils sont les suivants :<\/p>\n\n
WP_REST_Server::READABLE<\/code> m\u00e9thode ‘ GET<\/code>‘<\/li>\nWP_REST_Server::EDITABLE<\/code> m\u00e9thodes ‘ POST<\/code>‘, ‘ PUT<\/code>‘ et ‘ PATCH<\/code>‘<\/li>\nWP_REST_Server::DELETABLE<\/code> m\u00e9thode ‘ DELETE<\/code>‘<\/li>\nWP_REST_Server::ALLMETHODS<\/code> toutes les m\u00e9thodes ci-dessus<\/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>nous avons d\u00e9fini notre point de terminaison personnalis\u00e9 comme ‘ awhitepixel\/v1\/getsomedata<\/code>‘. L’URL compl\u00e8te serait l’URL racine de l’API REST de WordPress pr\u00e9fix\u00e9e, qui est <yourdomain>\/wp-json<\/code>. Ainsi, l’URL compl\u00e8te du point de terminaison ci-dessus serait ‘ <yourdomain>\/wp-json\/awhitepixel\/v1\/getsomedata<\/code>‘. \u00c0 la ligne, #4<\/code>nous avons fourni un nom de fonction comme rappel, que nous ajouterons sous peu.<\/p>\nregister_rest_route()<\/code>de, vous devrez vider vos permaliens<\/strong> pour que cela fonctionne. Vous pouvez le faire en visitant Param\u00e8tres> Permaliens dans l’administrateur et cliquez simplement sur Enregistrer.<\/p>\n[rest_ensure_response](https:\/\/developer.wordpress.org\/reference\/functions\/rest_ensure_response\/)()<\/code>function ou cr\u00e9er une instance d’ WP_REST_Response<\/code>object comme retour du rappel. En tant que param\u00e8tre de la fonction de rappel, nous obtenons un WP_REST_Request<\/code>objet qui contient toutes les informations sur la requ\u00eate, y compris tous les param\u00e8tres. Cr\u00e9ons une fonction de rappel simple qui envoie simplement du texte en r\u00e9ponse\u00a0:<\/p>\nfunction awhitepixel_rest_route_getsomedata( $request) {\n $response = 'Hello there!';\n return rest_ensure_response( $response );\n}<\/code><\/pre>\nrest_ensure_response()<\/code>s’assure que toutes les donn\u00e9es que nous fournissons (la cha\u00eene) sont converties en une r\u00e9ponse valide REST. \u00c9videmment, vous voudrez ajouter plus de code ici, soit pour faire quelque chose dans WordPress, soit pour r\u00e9cup\u00e9rer et renvoyer des donn\u00e9es.<\/p>\n<domain>\/wp-json\/awhitepixel\/v1\/getsomedata<\/code>dans le navigateur affichera la cha\u00eene "Hello there!".<\/p>\nAcceptation des param\u00e8tres<\/h3>\n
?<\/code>, s\u00e9par\u00e9e par &<\/code>au format cl\u00e9=valeur. Par exemple ‘ <endpoint>\/product\/?product_id=14<\/code>‘). Vous pouvez \u00e9galement d\u00e9finir un mod\u00e8le d’URL "plus joli", o\u00f9 les param\u00e8tres font partie du chemin. Par exemple ‘ <endpoint>\/product\/14\/<\/code>‘. Cette derni\u00e8re m\u00e9thode n\u00e9cessite cependant une certaine connaissance des regexes. La m\u00e9thode que vous choisirez d\u00e9pend de vous, je vais vous montrer les deux ci-dessous.<\/p>\nParam\u00e8tres GET<\/h4>\n
args<\/code>cl\u00e9 ‘ ‘ dans register_rest_route()<\/code>le troisi\u00e8me param\u00e8tre de. Pour chaque param\u00e8tre que vous souhaitez autoriser, d\u00e9finissez la valeur de cl\u00e9 (dans l’exemple ci-dessus ‘ product_id<\/code>‘) et un tableau d’options pour ce param\u00e8tre. En tant qu’options, vous pouvez d\u00e9finir le format du param\u00e8tre (s’il attend par exemple un nombre ou une cha\u00eene) et \u00e9galement d\u00e9cider si ce param\u00e8tre est requis ou non.<\/p>\nproduct_id<\/code>‘ comme nombre non requis.<\/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 se chargera de renvoyer une r\u00e9ponse d’erreur 400. De m\u00eame si vous passez un format invalide, par exemple "hello" comme valeur \u00e0 un param\u00e8tre qui attend un nombre.<\/p>\n#15<\/code>de la fonction de rappel, vous voyez comment obtenir la valeur du param\u00e8tre \u00e0 partir de la requ\u00eate\u00a0; en utilisant la m\u00e9thode get_param()<\/code>dans l’objet pass\u00e9 WP_REST_Request<\/code>. \u00c0 titre d’exemple, je montrerai diff\u00e9rentes r\u00e9ponses selon qu’elles product_id<\/code>ont \u00e9t\u00e9 fournies ou non (rappelez-vous que nous l’avons d\u00e9fini comme facultatif). La logique de modification de votre code en fonction des param\u00e8tres fournis d\u00e9pend enti\u00e8rement de vous et de votre projet. Vous pouvez avoir moins de points de terminaison qui acceptent un grand nombre de param\u00e8tres, ou beaucoup plus de points de terminaison distincts pour chaque cas sp\u00e9cifique.<\/p>\n<yourdomain>\/awhitepixel\/v1\/getsomedata<\/code>et "Return product data for ID 14" lorsque je vais sur <yourdomain>\/awhitepixel\/v1\/getsomedata\/?product_id=14<\/code>.<\/p>\nParam\u00e8tres dans le cadre du chemin<\/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>\u00e0 la fin. Ce mod\u00e8le signifie que nous devons collecter un nombre (d<\/code>) de n’importe quelle longueur (+<\/code>) et affecter la valeur collect\u00e9e dans la cl\u00e9 de param\u00e8tre product_id<\/code>. Et dans notre fonction de rappel, nous utilisons exactement la m\u00eame m\u00e9thode que lors de la configuration des param\u00e8tres GET\u00a0; get_param()<\/code>dans l’ WP_REST_Request<\/code>objet fourni \u00e0 la fonction.<\/p>\n