API JavaScript
WordPress Playground propose un client API JavaScript qui vous permet de contrôler entièrement votre WordPress.
API ne signifie pas ici « API REST »
WordPress Playground est une application qui fonctionne dans le navigateur. Le terme API désigne ici un ensemble de fonctions que vous pouvez appeler en JavaScript. Il ne s’agit pas d’une API REST accessible par le réseau.
Démarrage rapide
Pour utiliser l’API JavaScript, vous aurez besoin de :
- Un élément
<iframe> - Le client JavaScript de Playground, chargé depuis
playground.wordpress.netou installé avec npm
Charger le client depuis playground.wordpress.net
Vous pouvez charger le client directement depuis https://playground.wordpress.net/client/index.js. Aucune installation avec npm ni étape de compilation n’est nécessaire. Utilisez un élément <script type="module"> pour importer le client et utiliser await.
Enregistrez l’exemple suivant dans un fichier index.html et ouvrez-le à l’aide d’un serveur web local, ou collez-le dans un éditeur HTML en ligne comme CodePen ou JSFiddle :
<iframe id="wp" style="width: 100%; height: 300px; border: 1px solid #000;"></iframe>
<script type="module">
const { startPlaygroundWeb } = await import('https://playground.wordpress.net/client/index.js');
const client = await startPlaygroundWeb({
iframe: document.getElementById('wp'),
remoteUrl: 'https://playground.wordpress.net/remote.html',
});
// Attendez que Playground soit entièrement chargé
await client.isReady();
</script>
L’importation charge le client JavaScript dans votre page. startPlaygroundWeb() charge ensuite WordPress dans l’iframe à l’aide de remoteUrl et renvoie un client qui permet de le contrôler.
/remote.html est une URL spéciale
/remote.html est une URL spéciale qui charge le point d’accès à l’API Playground au lieu de l’application de démonstration avec son interface de navigation. Découvrez la différence entre / et /remote.html.
Utilisez https://playground.wordpress.net/remote.html pour remoteUrl afin de vous connecter à Playground. Les pages WordPress se chargent automatiquement depuis wpsandbox.wordpress.net. Vous n’avez pas besoin de configurer cette adresse.
Installer le client avec npm
Si votre application utilise un outil de regroupement de modules (bundler), installez le paquet du client :
npm install @wp-playground/client
Remplacez ensuite l’importation par URL de l’exemple ci-dessus par cette importation dans votre module JavaScript :
const { startPlaygroundWeb } = await import('@wp-playground/client');
Pour utiliser l’environnement hébergé à l’adresse https://playground.wordpress.net/remote.html, utilisez l’importation par URL ci-dessus pour garder le client et l’environnement synchronisés. Avec npm, utilisez des versions correspondantes du client et de l’environnement et mettez-les à jour ensemble.
Contrôler le site web
Maintenant que vous disposez d’un objet client, vous pouvez l’utiliser pour contrôler le site web dans l’iframe. Il existe trois façons de le faire :
Débogage et tests
Pour faciliter les tests et le débogage, le client API JavaScript est accessible via window.playground dans index.html et remote.html.
> await playground.listFiles("/")
(6) ['tmp', 'home', 'dev', 'proc', 'internal', 'wordpress']
Dans index.html, playground est un objet Proxy et le navigateur ne propose pas de saisie semi-automatique. Dans remote.html, playground est une instance de classe et vous bénéficiez de la saisie semi-automatique du navigateur.