_fields (paramètre REST)

Définition : _fields est un paramètre global de la REST API WordPress qui limite les propriétés retournées dans une réponse. Il aide les clients à recevoir seulement les informations dont ils ont besoin.

Comprendre et utiliser

À quoi sert cette notion ?

Il réduit la taille des échanges et rend plus clair le contrat consommé par une interface, notamment lorsqu’une collection possède de nombreuses métadonnées.

Fonctionnement technique

Le paramètre accepte une liste de champs séparés par des virgules, et certaines propriétés imbriquées peuvent être ciblées par leur chemin. Il n’élargit pas les permissions de lecture.

Dans quel contexte l’utiliser ?

Une page de résultats ATOOLPHA n’a besoin que de l’identifiant et du titre des publications visibles.

Étude de cas : application professionnelle

Un tableau de bord n’a pas besoin de télécharger chaque champ d’un article pour afficher une simple liste de titres. En demandant id, title et link avec _fields, le client réduit la taille de la réponse et le travail de traitement. Mesurer la différence sur une collection de test, puis activer éventuellement _embed pour l’auteur. Si les ressources intégrées disparaissent, comprendre que _fields peut exclure des propriétés structurelles nécessaires. Cette optimisation doit donc être contrôlée fonctionnellement : le JSON plus petit n’est pas un progrès si l’interface devient incomplète.

Exemple technique commenté

Les lignes ci-dessus sont des exemples de requêtes HTTP, non des commandes prêtes à coller dans un article. Pour les essayer, utiliser un client HTTP et un site de test. Toute opération d'écriture nécessite un compte autorisé, une authentification appropriée et une sauvegarde du jeu de données concerné.

GET /wp-json/wp/v2/posts?_fields=id,title,link&per_page=5

Décryptage du code et résultat attendu

Le serveur restreint la représentation à trois champs principaux. Les autorisations et le contexte s’appliquent toujours avant la livraison.

Exercice guidé pour vérifier la notion

Comparer la taille JSON des réponses avec et sans _fields et vérifier la présence des champs indispensables à l’interface.

Précautions et limites

Pour combiner _fields avec _embed, conserver les propriétés techniques _links et _embedded nécessaires au résultat attendu.

À ne pas confondre

_fields choisit les propriétés de chaque objet ; per_page choisit le nombre maximal d’objets par réponse.

Diagnostic avancé

Si une ressource imbriquée disparaît après optimisation, inspecter les champs listés et les besoins du paramètre _embed.

Choix d’architecture et déploiement

Spécifier les champs réellement utilisés sans présumer que tous les serveurs ou extensions exposent exactement les mêmes propriétés.