Pular para o conteúdo principal

API JavaScript

O WordPress Playground vem com um cliente de API JavaScript que oferece controle total sobre o seu WordPress.

API aqui não significa "REST API"

O WordPress Playground é uma aplicação baseada em navegador. O termo API aqui se refere a um conjunto de funções que você pode chamar dentro do JavaScript. Isso não é uma API REST baseada em rede.

Início rápido​

Para usar a API JavaScript, você vai precisar de:

  • Um elemento <iframe>
  • O pacote @wp-playground/client (do npm ou de um CDN)

Aqui está o exemplo mais curto de como usar a API JavaScript em uma página HTML:

<iframe
	id="wp"
	style="width: 100%; height: 300px; border: 1px solid #000;"
></iframe>
<script type="module">
	// Use unpkg for convenience
	import { startPlaygroundWeb } from 'https://playground.wordpress.net/client/index.js';

	const client = await startPlaygroundWeb({
		iframe: document.getElementById('wp'),
		remoteUrl: `https://playground.wordpress.net/remote.html`,
	});
	// Let's wait until Playground is fully loaded
	await client.isReady();
</script>
/remote.html é uma URL especial

/remote.html é uma URL especial que carrega o endpoint da API do Playground em vez do aplicativo de demonstração com a interface do navegador. Leia mais sobre a diferença entre / e /remote.html nesta página.

Controlando o site​

Agora que você tem um objeto client, pode usá-lo para controlar o site dentro do iframe. Existem três maneiras de fazer isso:

Depuração e testes​

Para testes e depuração rápidos, o cliente da API JavaScript é exposto como window.playground tanto em index.html quanto em remote.html.

> await playground.listFiles("/")
(6) ['tmp', 'home', 'dev', 'proc', 'internal', 'wordpress']

Note que em index.html, playground é um objeto Proxy e você não terá autocompletar do navegador. Já em remote.html, porém, playground é uma instância de classe e você se beneficiará do autocompletar do navegador.