Usando a ferramenta create-block


A ferramenta create-block do WordPress permite criar rapidamente a estrutura básica de um novo plugin de bloco.

Nesta lição, você aprenderá o que é necessário para começar a usar o create-block, como utilizá-lo e revisará o código que ele gera.

Timestamps

  • Introdução: 0:00 – 1:04
  • Requisitos de software: 1:04 – 2:07
  • Instalando o nvm e o Node/npm no macOS/Linux: 2:07 – 3:54
  • Instalando o nvm e o Node/npm no Windows: 3:54 – 5:14
  • Usando o create-block para criar a estrutura básica de um bloco: 5:14 – 8:46

Resultados de aprendizagem

  1. Aprenda o que é a ferramenta create-block
  2. Entenda quais softwares são necessários para usar o create-block
  3. Aprenda a instalar qualquer software necessário
  4. Revise o código criado pelo create-block

Perguntas de compreensão

  1. O que é a ferramenta create-block e para que ela é usada?
  2. Quais ferramentas e softwares são necessários para usar o create-block?
  3. Qual comando é executado para usar o create-block?
  4. Qual é o nome do diretório que o create-block cria para os arquivos finais do bloco?

Transcrição do vídeo

Ver transcrição

Olá, e boas-vindas ao Learn WordPress.

Neste tutorial, você aprenderá a usar a ferramenta create-block para criar a estrutura básica de um novo plugin de bloco. Neste vídeo, abordaremos o que é a ferramenta create-block, quais softwares você precisa para usá-la, como criar a estrutura básica de um novo bloco usando o create-block e o código gerado pelo create-block.

O create-block é uma ferramenta oficial de linha de comando desenvolvida por colaboradores do WordPress para criar a estrutura básica ou criar um novo plugin de bloco. Ela gera tudo o que você precisa para começar um novo plugin de bloco e integra uma configuração de compilação moderna sem necessidade de configuração. Você pode saber mais sobre o create-block visitando o manual do Block Editor na página de recursos para desenvolvedores do WordPress, em Guias de referência -> Pacotes -> @wordpress/create-block.

para usar a ferramenta create-block, você precisará de uma instalação local do WordPress, um terminal para executar comandos e o Node.js e o npm. Você pode usar qualquer instalação local do WordPress com a qual esteja familiarizado, como o LocalWP ou o DesktopServer. Se ainda não tiver uma instalação local do WordPress, consulte o tutorial Instalações locais do WordPress para iniciantes em learn.wordpress.org.

Se você estiver usando Mac OS ou qualquer sistema operacional Linux, poderá usar o terminal integrado. Para usuários do Windows, recomendamos instalar e usar o PowerShell, que pode ser encontrado em microsoft.com/powershell.

Por fim, você precisa instalar o Node.js, que também instala o npm. A ferramenta create-block funcionará com qualquer versão estável do Node.js superior à versão 12. No entanto, dependendo dos seus requisitos de desenvolvimento, talvez seja necessário poder alternar rapidamente entre versões do Node.js em diferentes projetos. Felizmente, você pode fazer isso usando o gerenciador de versões do node de código aberto, também conhecido como nvm. Para encontrá-lo, acesse nvm.sh, que direcionará você para a página do GitHub. O grande benefício de usar o nvm é que, se os requisitos de versão mudarem, será muito fácil atualizar sua versão do Node.js usando o nvm. Para os fins deste tutorial, instalaremos a mesma versão necessária para o desenvolvimento do core do Bloco, listada no manual do Block Editor, na página do ambiente de desenvolvimento Começando.

Atualmente, recomenda-se instalar a versão 14 do Node.js. Se você estiver usando macOS ou Linux, poderá abrir o aplicativo de terminal padrão e instalar o nvm executando o script de instalação do npm que você copia da documentação do nvm.

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

Depois que o npm estiver instalado, você precisará fechar o terminal e reabri-lo.

Em seguida, você poderá usar o comando nvm install para instalar as versões do Node.js e do npm necessárias.

nvm install 14

Se estiver usando um computador com Windows, será necessário instalar o gerenciador de pacotes Chocolatey para Windows para instalar o nvm. Primeiro, abra o PowerShell com privilégios administrativos clicando com o botão direito do mouse no item de menu do PowerShell e selecionando Executar como administrador. Em seguida, acesse a documentação de configuração do Chocolatey e role até as instruções de instalação com o PowerShell. Copie as instruções e clique com o botão direito na janela do PowerShell para colá-las.

Depois que o Chocolatey estiver instalado, use o comando a seguir para instalar o nvm:

choco install -y nvm

Depois que o nvm estiver instalado, use o comando nvm install para instalar as versões necessárias do Node.js e do npm;

nvm install 14

Por fim, execute o comando nvm use para usar a versão do Node.js e do npm que você acabou de instalar.

nvm use 14.20.0

Agora você está pronto para usar a ferramenta create-block para criar seu primeiro bloco. No terminal, altere o diretório para o diretório de plugins do conteúdo do WP da sua instalação local do WordPress. No meu caso, ele é:

cd development/websites/wordpress/wp-content/plugins

Em seguida, execute o comando create-block e passe um slug de plugin para esse comando. O slug é o nome exclusivo do plugin.

npx @wordpress/create-block wp-learn-todo

Isso criará um novo plugin no diretório wp-learn-todo, instalará os pacotes necessários e criará os arquivos necessários. Você perceberá que não precisamos instalar o pacote create-block. O comando npx nos permite executar o pacote a partir do local em que ele está hospedado na nuvem.

Depois que a estrutura básica do novo plugin for criada, você deverá ter uma nova pasta de plugin na instalação do WordPress com o nome do slug passado ao create-block.

Lá está ele: wp-learn-todo. Vamos analisar os diretórios e arquivos mais importantes desse plugin.

O diretório build é o local onde os arquivos finais de recursos do bloco serão compilados para distribuição. node_modules contém todos os pacotes ou módulos do node necessários para o desenvolvimento. O diretório src, ou diretório de código-fonte, é onde você fará a maior parte da codificação; todo o código do seu bloco fica aqui. O package.json é o arquivo que determina de quais pacotes o seu código precisa. O readme.txt é um arquivo usado pelo repositório de plugins WordPress.org para gerenciar seu plugin. E o arquivo wp-learn-todo.php é o arquivo principal do plugin que informa ao WordPress que este é um plugin.

Se abrirmos o WordPress e formos para o Block Editor, deveremos conseguir adicionar este bloco. Primeiro, precisaremos ativar o bloco, e o learn-todo está ativado. Vamos criar uma nova publicação e adicionar um novo bloco. Aqui está. No momento, ele contém apenas um parágrafo com algum texto.

E assim terminamos este tutorial sobre como usar o create-block. Se você estiver pronto para começar a criar blocos personalizados, confira o tutorial Adicionando suporte a blocos a um plugin existente. Para ver mais tutoriais de desenvolvimento para WordPress, visite learn.wordpress.org.

Boa programação.

Introdução

Nesta lição, você aprenderá sobre uma ferramenta de linha de comando chamada Create Block e como usá-la para criar a estrutura básica de um novo plugin de bloco.

O create-block é uma ferramenta oficial de linha de comando desenvolvida por colaboradores do WordPress para criar a estrutura básica ou criar um novo plugin de bloco.

Ela gera tudo o que você precisa para começar um novo plugin de bloco e integra uma configuração de compilação moderna sem necessidade de configuração.

Você pode saber mais sobre o create-block visitando a página do manual do Block Editor.

Requisitos

Para usar a ferramenta create-block, você precisará de uma instalação local do WordPress, um terminal para executar comandos, além do Node.js e do npm. 

Você pode usar qualquer instalação local do WordPress com a qual esteja familiarizado. Se ainda não tiver uma instalação local do WordPress, consulte o tutorial Instalações locais do WordPress (para iniciantes) em learn.wordpress.org:

Se você estiver usando MacOS ou qualquer sistema operacional Linux, poderá usar o terminal integrado. Para usuários do Windows, recomendamos instalar e usar o PowerShell.

Por fim, você precisa instalar o Node.js, que também instala o gerenciador de pacotes npm:

É importante garantir que você use a versão correta do Node.js. Felizmente, você pode fazer isso usando o gerenciador de versões do node de código aberto, também conhecido como nvm.

O grande benefício de usar o nvm é que, se os requisitos de versão mudarem, será muito fácil atualizar sua versão do Node.js usando o nvm.

Instalação

Se você estiver usando MacOS ou Linux, poderá abrir o aplicativo de terminal padrão e instalar o nvm executando o script de instalação do nvm, copiado da documentação do nvm. 

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

Depois que ele estiver instalado, você poderá usar o comando nvm install para instalar as versões do Node.js e do npm necessárias.

nvm install 14

Se você estiver usando um computador com Windows, precisará instalar o gerenciador de pacotes Chocolatey para Windows para instalar o nvm. Mais especificamente, você deve instalar a CLI do Chocolatey para PowerShell

Primeiro, abra o Powershell com permissões de administrador clicando com o botão direito do mouse no item de menu do Powershell e selecionando Executar como administrador.

Acesse a documentação de configuração da CLI do Chocolatey e role até as instruções “Instalar com o PowerShell”. 

Copie as instruções e clique com o botão direito na janela do Powershell para colá-las. 

Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))

Pressione a tecla Enter para executar o comando

Depois que o Chocolatey estiver instalado, use o comando a seguir para instalar o nvm.

choco install -y nvm

Depois que o nvm estiver instalado, use o comando nvm install para instalar as versões necessárias do Nodejs e do npm.

nvm install 14

Por fim, execute o comando nvm use para usar a versão do Node.js que você acabou de instalar.

Usando o Create Block

Agora você está pronto para usar a ferramenta create-block para criar seu primeiro bloco. No terminal, altere o diretório para o diretório /wp-content/plugins da sua instalação local do WordPress.

Em seguida, execute o comando create-block e passe um slug de plugin para esse comando. O slug é o nome exclusivo do plugin.

npx @wordpress/create-block wp-learn-todo

Isso criará um novo plugin no diretório wp-learn-todo, instalará os pacotes necessários e criará os arquivos necessários.

Depois que a estrutura básica do novo plugin for criada, você deverá ter uma nova pasta de plugin na instalação do WordPress com o nome do slug passado ao create-block. 

Os diretórios e arquivos mais importantes:

  • build – este é o local onde os arquivos finais de recursos do bloco serão compilados para distribuição
  • node_modules – quaisquer pacotes/módulos do node necessários para o desenvolvimento
  • src – o diretório de código-fonte, onde você fará a maior parte da codificação. Todo o código do seu bloco fica aqui. 
  • Package.json – o arquivo que determina de quais pacotes o seu código precisa
  • Readme.txt – o arquivo usado pelo repositório de plugins WordPress.org
  • wp-learn-todo.php – o arquivo principal do plugin que informa ao WordPress que este é um plugin

Ative este plugin pelo painel do WordPress e, se abrir o editor de blocos, você poderá adicionar o bloco WP Learn Todo, que no momento contém apenas um parágrafo com algum texto.

E assim terminamos esta lição sobre como usar o Create Block.

Para aprender a usar este código para converter um shortcode em um bloco, por que não assistir ao tutorial Convertendo um shortcode em um bloco?

Recursos adicionais