En bref. Lire yoast_head et yoast_head_json dans les réponses REST de WordPress, ou html et json via le point d’accès par URL de Yoast.
Définition : Un site WordPress découplé (headless) utilise WordPress pour gérer le contenu, avec une interface publique (frontend) séparée. L’API REST de Yoast fournit les métadonnées des pages sous forme de HTML prêt à l’emploi ou de JSON structuré, que cette interface se charge de restituer.
Points clés
- Au 17 octobre 2026, la documentation de l’API REST de Yoast associe
yoast_headau HTML etyoast_head_jsonaux données structurées. - L’annonce de Yoast sur la prise en charge des architectures headless présente l’accès aux métadonnées sous forme de clés et de valeurs individuelles dans la version 16.7.
- Le guide de configuration du point d’accès de Yoast indique que le point d’accès aux données d’en-tête de l’API REST est activé par défaut.
Quel point d’accès renvoie les métadonnées ?
La documentation de l’API REST de Yoast donne ces exemples de requêtes :
https://yoast.com/wp-json/wp/v2/posts?slug=wordpress-seo
https://yoast.com/wp-json/yoast/v1/get_head?url=https://yoast.com/wordpress-seo/
La réponse de WordPress comprend yoast_head et yoast_head_json lorsque Yoast SEO est actif. Le point d’accès par URL renvoie html, json et status. La correspondance est la suivante :
| Réponse de WordPress | Point d’accès par URL | Contenu |
|---|---|---|
yoast_head | html | HTML prêt à l’emploi |
yoast_head_json | json | Métadonnées structurées |
La propriété status de la réponse obtenue par URL représente un code d’état HTTP, généralement 200 ou 404.
Quel format utiliser dans le frontend ?
Les consignes d’intégration de Yoast recommandent le HTML prêt à l’emploi, qui comprend les balises de métadonnées et le balisage schema.org destinés à l’élément <head> du document. Pour un rendu personnalisé, l’objet structuré donne accès aux valeurs individuelles ; Yoast recommande de comparer le résultat avec son HTML prêt à l’emploi.
Un réglage documenté du balisage schema.org demande une attention particulière. La documentation de l’API Schema de Yoast explique que la désactivation de ce balisage avec le filtre wpseo_json_ld_output le supprime de yoast_head, tandis que yoast_head_json conserve les données correspondantes. La documentation attribue cette différence à des chemins d’exécution distincts pour le HTML et le JSON : le filtre contrôle la sortie du script côté frontend, tandis que le chemin du JSON brut contourne ce filtre. Un frontend qui exploite les métadonnées structurées doit donc tenir compte de cette différence lorsqu’il met en œuvre la suppression du balisage schema.org.
Comment obtenir moins de champs dans une réponse ?
La documentation des paramètres globaux de WordPress définit _fields, un paramètre de requête qui limite les propriétés de la réponse. Appliqué à la requête sur les articles documentée par Yoast, il permet de demander uniquement les métadonnées :
https://yoast.com/wp-json/wp/v2/posts?slug=wordpress-seo&_fields=yoast_head,yoast_head_json
Cet exemple combine la syntaxe de sélection des champs de WordPress et les noms de champs de Yoast. WordPress accepte les noms de champs séparés par des virgules et ignore les champs inutiles lors de la construction de la réponse. La même documentation explique que limiter les propriétés renvoyées réduit la taille de la réponse JSON. Une requête existante qui sélectionne des champs doit inclure les propriétés Yoast nécessaires dans cette sélection.
Termes associés
- JSON-LD
- Données structurées
- Comment définir une URL canonique personnalisée dans Yoast SEO ?
- Pourquoi l’API REST de Yoast peut-elle signaler une URL introuvable ?
Questions fréquentes
Quelle version fournit les métadonnées structurées ?
L’annonce de la version 16.7 de Yoast présente l’accès en JSON aux balises de métadonnées et au balisage schema.org, sous forme de clés et de valeurs individuelles. Elle décrit ce format comme une prise en charge destinée aux développeurs qui construisent un frontend séparé.
Où puis-je activer le point d’accès ?
Les instructions de configuration de Yoast situent le réglage sous Yoast SEO, Settings, Site features, Technical SEO. Placez l’interrupteur REST API endpoint sur On et sélectionnez Save changes.
Puis-je modifier les métadonnées avec cette API ?
La documentation de l’API REST de Yoast décrit l’API comme accessible en lecture seule. Elle permet de lire les métadonnées ; leur mise à jour par POST ou PUT n’est pas prise en charge.
Sources
- Yoast, « Yoast SEO: REST API », sans date
- Yoast, « Yoast SEO 16.7: Extended headless support », 13 juillet 2021
- Yoast, « How to disable or enable the REST API endpoint in Yoast SEO », sans date
- Yoast, « Schema - API documentation », sans date
- WordPress, « Global Parameters », mis à jour le 14 octobre 2026
Vérifiez comment une page se lit pour les moteurs de réponse. Ouvrir l’analyseur de score GEO