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 que funciona no navegador. O termo API aqui se refere a um conjunto de funções que você pode chamar no 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 cliente JavaScript do Playground, carregado de playground.wordpress.net ou instalado pelo npm

Carregar o cliente de playground.wordpress.net​

Você pode carregar o cliente diretamente de https://playground.wordpress.net/client/index.js. Não é necessário instalar pacotes pelo npm nem compilar o projeto. Use um elemento <script type="module"> para importar o cliente e usar await.

Salve o exemplo a seguir como index.html e use um servidor web local para abri-lo, ou cole o código em um editor HTML on-line, como 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',
});
// Aguarde até que o Playground esteja totalmente carregado
await client.isReady();
</script>

A importação carrega o cliente JavaScript na sua página. Em seguida, startPlaygroundWeb() carrega o WordPress no iframe usando remoteUrl e retorna um cliente que permite controlá-lo.

/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.

Use https://playground.wordpress.net/remote.html em remoteUrl para se conectar ao Playground. As páginas do WordPress são carregadas de wpsandbox.wordpress.net automaticamente. Você não precisa configurar esse endereço.

Instalar o cliente pelo npm​

Se sua aplicação usa um empacotador de módulos (bundler), instale o pacote do cliente:

npm install @wp-playground/client

Em seguida, substitua a importação por URL do exemplo acima por esta importação no seu módulo JavaScript:

const { startPlaygroundWeb } = await import('@wp-playground/client');

Para usar o ambiente hospedado em https://playground.wordpress.net/remote.html, use a importação por URL acima para manter o cliente e o ambiente sincronizados. Com npm, use versões correspondentes do cliente e do ambiente e atualize os dois juntos.

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']

Em index.html, playground é um objeto Proxy e você não terá preenchimento automático no navegador. Já em remote.html, playground é uma instância de classe e oferece preenchimento automático.