Código Boilerplate como um termo é frequentemente usado de maneira depreciativa, pois ninguém parece gostar particularmente de escrevê-lo (incluindo desenvolvedores do WordPress). Refere-se ao código que é repetido em muitos lugares sem alteração como andaime, antes de escrever o código que realmente faz alguma coisa. Algumas linguagens como Java e C++ foram criticadas por serem assim. Mas todo esse andaime, no entanto, está lá por uma razão. Ou seja, fornecer e aplicar princípios de boa organização na estrutura do código (Boas práticas).

No contexto de temas e plugins do WordPress, os benefícios do uso de código clichê são demonstrados de forma mais clara e direta. Existem vários projetos do WordPress que fornecem uma coleção de código clichê bem pensado, que pode ajudá-lo a organizar seu código e evitar erros.

O que é código clichê?

O código Boilerplate é basicamente um esqueleto de diretórios e arquivos de código-fonte que você pode usar no desenvolvimento de seu projeto. Os diretórios ajudam a organizar os vários arquivos de código-fonte em seus devidos lugares e, geralmente, a estrutura espelha a da sua plataforma de desenvolvimento.

No caso de plugins do WordPress, os arquivos de código-fonte geralmente contêm definições de função de espaço reservado, valores e comentários que descrevem qual parte do código vai para onde. Os temas Boilerplate WordPress também fornecem uma estrutura de diretórios com esqueletos js e arquivos CSS organizados e anotados.

Benefícios do clichê no desenvolvimento do WordPress

Todos os plugins do WordPress têm algumas funções comuns, como ativação, desativação, bem como os vários ganchos que precisam ser implementados. Um código clichê pode fornecer uma estrutura comum, que é bem projetada e impõe boas práticas de software. Há três coisas boas que você consegue com o uso de código clichê: melhor qualidade de código, manutenção mais fácil e desenvolvimento mais rápido. E estes, por sua vez, fazem de você um melhor desenvolvedor WordPress.

Melhor qualidade de código

Embora a qualidade do código do núcleo do WordPress seja ótima, esse geralmente não é o caso dos plugins do WordPress. Uma consequência natural do uso do clichê é a padronização. Plugins que obedecem a um padrão que impõe boas práticas, possuem código mais limpo e o mais importante, no lugar certo. O Boilerplate também incentiva os desenvolvedores a implementar a interface e a funcionalidade do plug-in em sua totalidade. Ao fornecer esse andaime, ele ajuda você a não deixar algo de fora ou implementá-lo mal em algum lugar errado.

Também é uma grande ajuda para desenvolvedores iniciantes do WordPress devido ao fato de que tudo é apresentado corretamente e anotado com comentários.

Manutenção mais fácil

Todos os itens acima levam a uma manutenção mais fácil. O código que é escrito usando clichê é mais fácil de ser lido, entendido e solucionado. Com a padronização, um desenvolvedor pode pegar seu código e saber exatamente onde procurar. No entanto, não é apenas para os outros desenvolvedores do WordPress, mas para você também. O código que foi escrito há uma semana e ainda está fresco em sua mente, rapidamente se tornará incompreensível em alguns meses.

Desenvolvimento mais rápido

O código padrão também ajuda a acelerar os tempos de desenvolvimento. Ao fornecer a você um esqueleto funcional completo do projeto, ele permite que você comece a escrever código e design nos locais que importam. Você não precisa gastar tempo organizando código ou descobrindo quais funções padrão ou componentes CSS você precisa e, em seguida, escrevê-los.

Mas o maior ganho é quando você cria seus próprios pacotes clichê mais avançados. Se você costuma construir certos tipos de sites WordPress, como e-commerce ou páginas pessoais, a mágica acontece. Você pode escrever um pacote com arquivos esqueleto que contêm código de espaço reservado e recursos de tema que são comuns em todos os projetos de um determinado tipo. Dessa forma, você apenas descompacta o pacote e começa a preenchê-lo apenas com as especificidades do projeto.

Hospede seu site com a Pressidium

GARANTIA DE DEVOLUÇÃO DO DINHEIRO DE 60 DIAS

VEJA NOSSOS PLANOS

Se você é um cliente Pressidium, você pode usar nossa ferramenta de clonagem que foi construída tendo em mente este conceito simples. Por exemplo, digamos que você criou um site WordPress de comércio eletrônico padrão na plataforma Pressidium. Você o clona com apenas um clique e começa a trabalhar nos detalhes, em vez de começar do zero a cada vez.

Usando o clichê em projetos do WordPress

Existem vários “sistemas” padronizados para o WordPress. Mas neste artigo, vamos nos concentrar em dois que são bem conhecidos e documentados: O WordPress Plugin Boilerplate e roots.io.

O WordPress Plugin Boilerplate se anuncia como uma “base padronizada, organizada e orientada a objetos para a construção de plugins WordPress de alta qualidade” e certamente entrega. Ele segue os padrões de API e documentação do WordPress, é construído sobre a API de plug-in do WordPress e fornece uma maneira elegante de localização. Vamos dar uma olhada em seu conteúdo:

Changelog.md
Este é o arquivo Changelog no Markdown.

plugin-name/
A pasta principal que contém todo o resto.

admin/
Todas as funcionalidades relacionadas à administração são colocadas aqui. Inclui três pastas relevantes, css , js e partials para isso.

includes/
Este diretório inclui classes para a funcionalidade de ativação/desativação, localização i18n e a classe do carregador para definir todas as funções/ganchos.

• class-plugin-name-activator.php
• class-plugin-name-deactivator.php
• class-plugin-name-i18n.php
• class-plugin-name-loader.php
• class-plugin-name.php
• index.php

languages/plugin-name.pot
Um arquivo .pot padrão que contém as strings localizadas para seu plug-in.

public/
Aqui você coloca todo o código de plug-in relacionado ao público. Novamente, você tem as pastas css , js e partials relevantes.

NOTA : Antes de começar, não se esqueça de renomear todas as ocorrências “plugin-name” para o nome do seu plugin.

Nosso segundo sistema padrão de escolha é muito mais complexo e, portanto, não é possível cobri-lo em sua totalidade neste artigo. No entanto, possui excelente documentação online. Os desenvolvedores também escreveram uma série de e-books para cada componente que você pode comprar no site oficial!

Roots.io é um sistema clichê avançado que oferece três componentes (Trellis, Bedrock e Sage) que podem ser usados ​​separadamente ou em conjunto. Ele foi projetado para ser usado em projetos do WordPress e não apenas em plugins ou temas. Possui recursos avançados, como provisionamento de máquina virtual por meio do Vagrant, gerenciamento de dependências com o Composer, suporte Sass para escrever folhas de estilo, correção automática de erros de Javascript, teste de navegador, otimização de imagens e muito mais. Ele é baseado no clichê HTML5 e vem com a versão mais recente do Bootstrap.

Em Fechamento

Existem muitos sistemas padronizados por aí, cada um atendendo a diferentes necessidades. Escolha Roots.io se você for um desenvolvedor WordPress avançado que precisa de uma solução completa de projeto WordPress, juntamente com recursos de integração e cadeia de ferramentas. Se você é um desenvolvedor iniciante do WordPress, ou apenas precisa de um clichê simples para começar a desenvolver seu plugin ou tema, o WordPress Plugin Boilerplate é o mais adequado para suas necessidades.