9 erros a serem evitados ao desenvolver plugins ou temas do WordPress

Procurando construir um plugin ou tema WordPress? Tenha em mente que o desenvolvimento bem-sucedido de plugins e temas inclui algumas tentativas e erros. Mesmo os desenvolvedores mais experientes ocasionalmente confundem seu código, e mesmo que seja impossível evitar erros por completo, existem alguns erros comuns que você pode evitar facilmente. Para ajudá-lo, reuni nove erros comuns a serem evitados ao desenvolver seu plugin ou tema do WordPress.

Erro nº 1: sacrificar a qualidade em favor de soluções rápidas

Alguns desenvolvedores tentam encontrar um atalho ao desenvolver um pequeno plugin ou tema. Eles codificam de forma inconsistente e tentam encontrar as soluções mais fáceis e rápidas.

No entanto, a verdade é que não há uma maneira fácil de desenvolver um plugin ou tema avançado e que funcione bem. Alguns plugins e temas podem ser desenvolvidos de forma relativamente rápida e fácil. Por exemplo, não levará muito tempo para desenvolver um plug-in que oculte todos os avisos do administrador ou um plug-in que injete um trecho de JavaScript. No entanto, quando se trata de plugins ou temas mais complexos, “trapacear” ou copiar pode resultar em funcionalidade ruim, além de causar vários erros e falhas de desempenho.

É crucial seguir as melhores práticas de codificação organizada, mesmo se você estiver apenas construindo um protótipo de plugin/tema. Lembre-se, muitos dos produtos mais populares começaram como protótipos. Se você optar por uma abordagem “rápida e suja”, começará a acumular dívidas técnicas desde o primeiro dia.

Desenvolver código limpo, bem escrito e otimizado aumentará seu tempo de desenvolvimento em 10-30%, mas definitivamente vale a pena a longo prazo. No final do dia, você obterá um plugin ou tema de fácil manutenção, com bom desempenho e funcional.

Erro nº 2: Falha ao rastrear alterações de código

Deixar de rastrear as alterações de código é outro erro comum que todos os desenvolvedores do WordPress devem evitar. Todos os temas e plugins devem ser gerenciados sob controle de versão, independente de você ser o único desenvolvedor do projeto ou não.

Todos os temas e plugins devem ser gerenciados sob controle de versão, independente de você ser o único desenvolvedor do projeto ou não.Tweet

Os sistemas de controle de versão ajudam você registrando e acompanhando todas as alterações. Isso permite que você e outros desenvolvedores trabalhem no mesmo projeto enquanto um tema ou plug-in é desenvolvido. Além disso, sistemas de controle de versão, como o Git, registram todas as alterações feitas por cada um dos desenvolvedores, o que é particularmente conveniente quando se trabalha em um projeto grande. Se você optar por usar o Git, recomendo usar o GitFlow como um fluxo de trabalho de ramificação saudável para gerenciamento de versões.

Erro nº 3: não usar namespaces

Os namespaces são úteis se você precisar criar regiões separadas para grupos de variáveis, classes e funções. Isso evita conflitos de plugins que estavam presentes antes das versões PHP 5.6 e superiores que não podiam ser controlados usando namespaces.

Aqui está um exemplo de um código-fonte que ilustra o namespace chamado geometria para JavaScript. Esta definição de pacote permite diferenciar a classe Circle de outras classes que poderiam ser definidas por outros programadores.

namespace Geometry;

class Circle {
    private $radius;

    public circle($r) {
        $radius = $r;
    }

    public get_radius() {
        return $radius;
    }
   
    public get_area() {
        return pi() * $radius * $radius;
    }
}

Erro nº 4: Não utilizar nonces do WordPress

Seguir as práticas de segurança modernas é tão importante quanto garantir a funcionalidade do seu plugin ou tema. O WordPress usa nonces para fornecer algum nível de proteção para validar a autenticidade das solicitações. Os nonces são particularmente úteis na prevenção de ataques Cross-Site Request Forgery (CSRF).

Para criar um nonce, use a função a seguir.

$nonce= wp_create_nonce( 'name');

Confira esta referência de código do WordPress se você não estiver familiarizado com nonces.

Inscreva-se e obtenha uma cópia gratuita do nosso

Livro de negócios de plug-in do WordPress

Exatamente como criar um próspero negócio de plugins WordPress na economia de assinaturas.

Compartilhe com um amigo

Digite o endereço de e-mail do seu amigo. Só enviaremos este livro por e-mail, honra do escoteiro.

Obrigado por compartilhar

Impressionante - uma cópia do 'The WordPress Plugin Business Book' acabou de ser enviada para . Quer nos ajudar a divulgar ainda mais? Vá em frente, compartilhe o livro com seus amigos e colegas.

Grato pela assinatura!

- acabamos de enviar sua cópia do 'The WordPress Plugin Business Book' para .

Compartilhar com um amigo Reenviar e-mail

Tem um erro de digitação no seu e-mail? clique aqui para editar o endereço de e-mail e enviar novamente.

Download

Erro nº 5: Não utilizar a funcionalidade principal do WordPress

Muitos desenvolvedores não conseguem utilizar todo o potencial da funcionalidade principal do WordPress existente. Alguns temas e plugins possuem arquivos correspondentes aos arquivos principais do WordPress, como Color Pickers e jQuery.

A criação de arquivos extras aumentará o tamanho final do pacote e o tempo de carregamento. Você precisará manter e atualizar esses arquivos regularmente, o que também leva tempo e esforço.

Ao utilizar o que o WordPress tem a oferecer, você pode criar temas ou plugins mais leves e funcionais.

Erro nº 6: Enfileiramento de arquivos JavaScript e CSS

Enfileirar arquivos JavaScript e CSS quando não são necessários é outro erro comum. Isso pode levar a um tempo de carregamento mais lento e a uma classificação do mecanismo de pesquisa recusada, pois cada arquivo enfileirado adiciona uma solicitação HTTP adicional.

Erro nº 7: Colocar código JavaScript em um único arquivo principal para temas avançados

Se você estiver desenvolvendo um tema avançado que é pesado em JavaScript, é melhor evitar colocar o código JavaScript em um único arquivo principal. Muitos desenvolvedores optam por colocar o código JavaScript do tema WordPress em um arquivo principal chamado main.js, theme.js ou custom.js. Existem várias razões pelas quais você não quer fazer isso. Primeiro, à medida que seu tema crescerá, o tamanho do arquivo também aumentará. Como esse arquivo será carregado em todo o site, cada página levará mais tempo para carregar.

Segundo, criar um único arquivo tornará mais difícil gerenciar o código. Por exemplo, você não poderá colocar funções, como wp_dequeue_script() para descarregar código em algumas páginas para melhorar a velocidade.

Aqui está um vídeo que explica um pouco mais sobre o assunto:

Lembre-se de que esse erro é relevante apenas para temas avançados com uma estrutura JavaScript complexa. Se o seu tema for mais simples e leve em JavaScript, colocar o código JavaScript no arquivo principal não prejudicará a funcionalidade do seu tema.

Erro nº 8: Falha ao criar opções adicionais para alterar o código

Quando uma atualização automática é realizada diretamente no código, todas as alterações manuais do código serão perdidas, a menos que sejam alteradas por meio de ações e filtros. Por isso é tão importante habilitar ações e filtros para alterações.

Dessa forma, você e outros desenvolvedores poderão modificar recursos sem editar o próprio plug-in ou o tema pai. Além disso, você poderá usar os filtros e ações para adicionar funcionalidades extras, como extensões ou complementos, ao plugin ou tema pai.

Erro nº 9: não usar práticas modernas de design de código

Deixar de usar as práticas corretas de design de código é o erro final ao fechar nossa lista. A organização correta do código deve ser escolhida dependendo do tamanho e da natureza do seu plugin.

Se você está planejando construir um pequeno plugin de propósito único que não requer uma extensão adicional, mais tarde, não há necessidade de usar arquiteturas complicadas com várias classes.

Se você estiver criando uma extensão de plug-in que funcione com outros plug-ins ou um plug-in que exija muito código, é melhor usar a abordagem de Programação Orientada a Objetos (OOP). A ideia principal por trás da OOP é organizar o código em pedaços, como classes para uma melhor organização.

Além disso, eu não recomendo misturar código PHP e código HTML juntos. É melhor mantê-los separados usando o padrão Model-View-Controller (MVC), especialmente se seu plugin for mantido por vários desenvolvedores.

Aprendizado

Como você aprendeu acima, os erros mais comuns geralmente não são intencionais, mas podem levar a consequências bastante decepcionantes.

Na revisão, os erros mais comuns são:

1. Sacrificar a qualidade em favor de soluções rápidas
2. Falha ao rastrear alterações de código
3. Falha ao usar namespaces
4. Não utilizar nonces do WordPress
5. Não utilizando a funcionalidade principal do WordPress
6. Enfileiramento de arquivos JavaScript e CSS
7. Colocando código JavaScript em um único arquivo principal para temas avançados
8. Falha ao criar opções adicionais para alterar o código
9. Falha ao usar práticas modernas de design de código

Embora cometer erros seja inevitável, agora que você sabe quais são, será mais fácil evitá-los.

Você cometeu algum outro erro ao criar seu tema ou plugin? Por favor, compartilhe sua experiência nos comentários abaixo e não perca esses outros 5 erros a serem evitados.

Com contribuições de Alyse Falk.