Aller au contenu principal
Version: 0.5.0

Api

Permet de créer une route API accessible à partir de /wp-json.

Exemple d'utilisation​

Dans cet exemple, on créer une route API accessible à /wp-json/elementum/v1/hello/thibault/29.

app/Controllers/MyController.php
#[Api(
    namespace: "elementum/v1",
    endpoint: "/hello",
    name: "theme.api",
    methods: "GET",
    params: [
        "name" => "string",
        "age" => "number",
    ],
)]
public function themeApi($params)
{
    $message = "Hey " . ucfirst($params['name']) . " ! Tu as " . $params['age'] . " ans";
    
    return [
        "message" => $message,
    ];
}

Réponse​

La réponse retourne un objet JSON.

{
    "message": "Hey Thibault ! Tu as 29 ans"
}

Arguments​

namespace​

string Namespace de la route.

endpoint​

string Endpoint de la route.
(optionnel) | /

name​

string Nom de la route.
(optionnel)

methods​

string|array Méthodes HTTP autorisées.
(optionnel) | GET

params​

array Paramètres de la route.
(optionnel) | []

permission​

boolean Si true, la route nécessite une permission. (optionnel) | false