Introdução ao WPPB Boilerplate para plug-ins WordPress

Como desenvolvedores do WordPress, temos a responsabilidade de construir plug-ins que beneficiem nossos usuários, não apenas pela funcionalidade que nossos plug-ins adicionam. Nossos plug-ins também devem evitar o carregamento de recursos desnecessários, não devem tornar o back-end lento e devem ser fáceis de usar, como o plug-in padrão WPPB.

Lembre-se de que o ecossistema WordPress se baseia em código-fonte aberto e os desenvolvedores se baseiam nos plug-ins uns dos outros. É o espírito do código aberto colaborar e criar códigos aprimorados juntos. Mas também precisamos de um quadro para trabalharmos em conjunto de forma eficaz. Por isso, Automático emprega diretrizes rígidas ao aceitar um plugin em seu repositório (o mesmo vale para temas).

Felizmente, existem desenvolvedores como Tom McFarlin e Devin Vinson. Eles criaram o Plug-in padrão WPPBque visa facilitar a construção de plug-ins do WordPress.

Por que usar um plug-in Boilerplate como o WPPB Boilerplate?

Primeiro de tudo, vamos falar sobre por que você deve considerar o uso de clichê em seu fluxo de trabalho de desenvolvimento.

Existem algumas situações em que o uso do padrão WPPB faz sentido:

  • Você está construindo um plugin do zero com uma equipe de desenvolvedores
  • O plugin deve ser publicado no repositório de plugins WP
  • Seu plugin se tornará obrigatório nos negócios de seus clientes e precisa ser confiável e estável
  • Você quer aprender sobre os padrões e práticas recomendadas de codificação do WordPress

Vamos analisar esses motivos um por um:

1º: Você está construindo um plugin do zero, com uma equipe de desenvolvedores.

Sempre que há vários desenvolvedores trabalhando na mesma base de código, ocorrem desafios que raramente os desenvolvedores individuais enfrentam. Você precisa ter certeza de que:

  1. Todo mundo entende a estrutura do arquivo.
  2. O propósito de cada arquivo e classe é claro.
  3. As funções estão bem documentadas
  4. Os desenvolvedores entendem onde colocar ações, retornos de chamada, etc.
  5. O processo de enviar alterações para seus sistemas de teste e ao vivo é claro.
Ler:  7 melhores hospedagem WordPress com certificados SSL grátis em 2024 (barato e premium)

Como desenvolvedor único, você geralmente não se preocupa muito com essas coisas. Você é o único trabalhando no plugin, então a estrutura é sua de qualquer maneira. Mas com muitos desenvolvedores, você precisa ter certeza de que o desenvolvedor A entende por que o desenvolvedor B está escrevendo código dessa maneira.

O padrão WPPB ajuda a evitar confusão, pois coloca todos na mesma página.

2º: O plug-in deve ser publicado no repositório de plug-ins WP

Como dito anteriormente, a Automattic impõe diretrizes rígidas aos plug-ins aceitos no repositório WP. O uso do padrão WPPB torna mais simples seguir essas diretrizes, pois o código já está escrito seguindo padrões de codificação e padrões de documentação. Assim, você economiza tempo navegando pelo códice do WordPress e pode começar a trabalhar imediatamente, simplesmente seguindo as estruturas fornecidas no padrão.

Além disso, os arquivos já estão organizados da maneira exigida pelo repositório do plugin. A estrutura do arquivo mostra claramente qual arquivo vai para onde e elimina todas as suposições.

3º: Os negócios dos seus clientes dependerão do seu plugin

Embora o desenvolvimento de um plugin estável e confiável deva ser sempre um objetivo, há situações em que você deseja que seu plugin seja sólido como uma rocha. Se o seu plugin executa ações sem as quais o negócio do seu cliente sofre, sua base de código precisa ser estável, eficiente e fácil de manter.

Ao usar um plug-in padrão como base, você descobrirá que trabalhar em seu código será mais simples quanto mais estiver acostumado com a estrutura padrão. Sem essa estrutura fixa, é fácil – inconscientemente – criar uma nova estrutura de plugins para cada projeto em que você está trabalhando. Isso tornaria muito difícil trabalhar em um código que você não tocava há 6 a 12 meses.

4º: Você deseja aprender sobre os padrões e práticas recomendadas de codificação do WordPress

Para se tornar um desenvolvedor melhor, você precisa aprender coisas novas constantemente e se adaptar às melhores práticas. Uma das maneiras mais rápidas de se familiarizar com os padrões de codificação do WordPress é estender um plugin que já os implementa. WPPB torna isso muito confortável. Você pode clonar qualquer um dos plug-ins de exemplo e comece a aprender.

Ler:  Vamos descobrir quanto tempo leva para enviar um vídeo para o YouTube?

Em breve você entenderá por que eles foram criados dessa maneira e como você pode adicionar funcionalidades personalizadas a eles.

Configure uma instalação local e navegue pelo código dos plug-ins de exemplo.

Primeiros passos com seu novo plug-in usando WPPB Boilerplate para WordPress

Chega de teoria, vamos mergulhar no uso do WPPB.

Para esta postagem, presumo que você tenha um site local instalado como ambiente de desenvolvimento. Ter o Git instalado na sua máquina ajuda, mas não é obrigatório.

O primeiro passo é ir até WPPB.me.

Como o padrão WPPB vem com muitos locais que fazem referência ao nome do plugin, slug, nome do autor, etc., é uma boa ideia usar o gerador WPPB.me ao baixar os arquivos. Você poderia clonar o repositório WPPB Githubmas isso deixaria todo o trabalho de pesquisa + substituição para você.

Para este exemplo, usaremos os seguintes detalhes:

Depois de clicar em “Build Plugin”, seu navegador baixará um arquivo zip que você poderá instalar em seu site local. Para isso, você pode usar o instalador normal do plugin ou descompactar o arquivo e colocá-lo em wp-content/plugins. Depois de ativar o plugin, você o verá aparecendo na sua lista de plugins.

Compreendendo a estrutura padrão do plug-in WordPress

Ok, o processo de geração e instalação do plugin não foi muito emocionante – mas necessário para começar. Para realmente começar a desenvolver com o plugin, vamos dar uma olhada na estrutura do arquivo.

Como seria de esperar, os arquivos estão muito bem organizados.

A pasta “admin” contém lógica e UIs que carregam na área WP-Admin do site. Todo desenvolvedor que olha para este plugin entende isso imediatamente.

A pasta “includes” contém a essência do plugin, aqui você colocará a maior parte da funcionalidade. Por exemplo, você pode estender class-my-plugin-activator.php para configurar tabelas de banco de dados personalizadas, tarefas wp-cron personalizadas ou para verificar outros plug-ins e dependências. Dentro de class-my-plugin-deactivator.php, você pode limpar o site quando seu plugin estiver desativado.

Seguindo o Padrões de Internacionalizaçãoclass-my-plugin-i18n.php carrega o domínio de texto dos plugins.

Independentemente do arquivo de plugin que você está vendo, você descobrirá que o código está excepcionalmente bem documentado.

Na captura de tela, você pode ver o arquivo principal do seu novo plugin, que para mim é o ponto de partida ideal para entender como funciona a lógica do plugin. Sempre que você encontrar a string “my-plugin” ou “My_Plugin”, lembre-se que eu a configurei no gerador. É por isso que prefiro gerar o padrão a apenas clonar o repositório do Github. Sem o gerador, você teria que passar por todos os arquivos do plugin e ajustar essas strings para corresponder ao nome do seu plugin.

Ler:  O que é comércio social?

Vamos abordar brevemente a estrutura de arquivos para ativos como arquivos JS ou CSS.

Para eliminar todas as suposições do desenvolvimento, o WPPB é organizado em pastas separadas para CSS, JS e parciais. Como seria de esperar, class-my-plugin-public.php é responsável por enfileirar CSS e JS corretamente e por carregar os parciais conforme necessário. Ao abrir o arquivo, você verá que ele usa wp_enqueue_script, wp_enqueue_style e wp regulares.

Se você não estiver familiarizado com o trabalho com parciais, recomendo que leia o Documentação do arquivo de modelo. “Um modelo parcial é uma parte de um modelo incluída como parte de outro modelo, como o cabeçalho de um site. Os parciais de modelos podem ser incorporados em vários modelos, simplificando a criação de temas.” – Documentação WordPress

Embora a documentação fale sobre a criação de temas, obviamente você também pode incluir parciais em plug-ins, tanto no backend quanto no frontend. Para o frontend, uma forma viável de usar um parcial pode ser incorporá-lo em um shortcode. No back-end, você pode querer usar parcial nas páginas de administração do seu plugin (que abordaremos neste artigo).

Obviamente, os arquivos estão quase vazios agora e apenas a lógica mais fundamental está em vigor. Isso é ótimo para iniciar um novo plugin do zero, mas pode não ser ideal para aprender como o código padrão funciona. Para aprender, recomendo que você instale o Plug-in de demonstração WPPB e familiarize-se com ele.

Exemplo: Configurando uma página de opções no back-end

Como você pode ver após ativar o WPPB Demo Plugin, há uma nova página de opções no menu “Plugins”.

Para examinar como esta página foi adicionada, vamos examinar o código do plugin.

Procurar o local onde a página “WPPB Demo Options” foi adicionada é simples, temos que olhar a pasta “admin”. Com base na estrutura de pastas, simplesmente não há outro lugar para colocar o código carregado na área WP-Admin.

Ler:  Encontre backlinks mais rápido para fazer seu blog crescer rapidamente

Este novo arquivo trata do conteúdo exibido na página de administração. Você pode examinar sua lógica e verá que ela é capaz de:

  • Exibindo cabeçalho, conteúdo ou rodapé
  • Salvando links para perfis sociais
  • Existem também exemplos para lidar com entradas

Por favor, veja essas funções como elas são: exemplos. Não espere que eles estejam profundamente integrados ao tema que você estiver usando. O objetivo deles é explicar como você pode criar funcionalidades semelhantes com seu novo plugin. O carregamento do conteúdo ocorre em class-wppb-demo-plugin-admin.php, na função load_dependencies() na linha 70.

Claro, depende inteiramente de você adicionar as configurações do plugin como um item no menu “Plugins”, como o item do menu principal ou como uma página de Opções. Você pode alterar a implementação a qualquer momento, modificando a função setup_plugin_options_menu() na linha 55 de class-wppb-demo-plugin-settings.php.

No entanto, sugiro que você se concentre na UX do backend. Nem sempre é uma boa ideia sobrecarregar o menu WP-Admin com páginas de menu, só porque você acha que seu plugin é mais importante do que outros plugins.

Conclusão sobre o plugin WPPB Boilerplate para WordPress

Para mim, o plugin padrão WPPB é uma base fantástica para construir um plugin WordPress do zero.

Acho que se adapta a projetos que:

  • Exigir que vários desenvolvedores trabalhem em um novo plugin
  • Planeje enviar o plugin para o repositório de plugins do WordPress
  • Deseja construir uma base de código confiável e sustentável
  • Destinam-se a familiarizar o desenvolvedor com os padrões de codificação do WordPress

O plugin padrão WPPB também pode ser um exagero, especialmente se você:

  • Quer construir um plugin MVP para validar uma ideia
  • Precisa de uma solução temporária para um problema simples

Tenha em mente que os desenvolvedores que trabalham com o código pela primeira vez precisarão se familiarizar com o padrão. Porém, depois de conhecerem o padrão do WPPB, eles estarão em uma boa posição para construir um plugin que siga os padrões de codificação e documentação do WordPress.

Precisa de um provedor de hospedagem WordPress mais rápido?

A solução Managed WordPress da Hostinger lida automaticamente com a compactação de imagens e todos os plug-ins e atualizações principais do WordPress para que você possa se concentrar na criação de um plug-in excepcional.

Comece com um WordPress totalmente gerenciado pela Hostinger.

Novas publicações:

Recomendação