do WordPress garantem consistência e facilidade de manutenção em toda a vasta base de código da plataforma. Essas diretrizes meticulosamente elaboradas sintetizam dicas de desenvolvimento para WordPress, promovendo clareza e eficiência.
Seguindo estes de manutenção do WordPress , desenvolvedores do mundo todo contribuem harmoniosamente, compreendendo o trabalho uns dos outros sem dificuldades. Incentive sua de desenvolvimento WordPress a seguir rigorosamente os padrões de codificação do WordPress para garantir soluções de alta qualidade, escaláveis e de fácil manutenção a longo prazo.
Por que seguir os padrões de codificação do WordPress?
Os padrões de codificação do WordPress visam garantir a consistência do código entre projetos e colaboradores. Isso melhora a legibilidade e a manutenção para o desenvolvimento colaborativo e facilita as revisões de código e a adesão às melhores práticas em todo o ecossistema WordPress.
Quais são os padrões de codificação do WordPress?
Os Padrões de Codificação do WordPress fornecem uma base para colaboração e consistência em todo o projeto e comunidade WordPress, desde o código principal até temas e plugins. Esses padrões, desenvolvidos pela comunidade WordPress em consulta com os fóruns de suporte do WordPress servem como boas práticas que desenvolvedores e colaboradores do WordPress devem seguir.
Saiba mais: Como reduzir o impacto de códigos de terceiros?
Importância dos padrões de codificação
Padrões de codificação ajudam a prevenir erros comuns, melhoram a legibilidade do código e simplificam as modificações. Ao segui-los, o código aparenta ter sido escrito por uma única pessoa, tornando-o mais fácil de entender e modificar para qualquer um.
Contribuição para o núcleo do WordPress
Se você pretende contribuir para o núcleo do WordPress, é crucial familiarizar-se com esses padrões, pois o código enviado deve estar em conformidade.
Está com dificuldades para manter os padrões de codificação do seu site WordPress exclusivo?
Deixe que nossos desenvolvedores especialistas em WordPress cuidem da dor de cabeça!
Componentes dos padrões de codificação do WordPress
Os padrões abrangem diretrizes específicas para cada linguagem, como CSS, HTML, JavaScript e PHP, além de diretrizes de acessibilidade alinhadas com o WCAG AA.
Leia também: Como converter HTML em tema do WordPress?
Exceção para bibliotecas de terceiros
No entanto, bibliotecas de terceiros incorporadas ao WordPress estão isentas dessas normas.
Exemplos de padrões de codificação do WordPress
Vamos explorar os padrões de codificação do WordPress por meio de vários exemplos para entender sua aplicação em cenários reais. Esses exemplos ilustram as melhores práticas recomendadas para escrever código claro e de fácil manutenção no WordPress.
PHP NO WORDPRESS
O WordPress utiliza o PHP como sua linguagem de programação principal. A adesão aos padrões de codificação PHP é crucial para manter um código consistente e de fácil manutenção no WordPress. Veja por que os padrões de codificação PHP são importantes:
Quebras de linha
O WordPress não especifica muito sobre quebras de linha, mas é comum adicionar uma após a maioria das instruções. Além disso, recomenda-se colocar definições de variáveis, blocos condicionais (if) e itens de arrays em linhas separadas.
Recuo
Para facilitar a leitura do seu código, use recuos para mostrar sua estrutura lógica. Use tabulações no início das linhas e espaços para recuos no meio das linhas.
Utilização do espaço
Para tornar seu código mais legível, remova espaços extras no final das linhas. Elimine também linhas em branco com tabulações ou espaços não separáveis. Use espaços dentro dos parênteses para maior clareza. Adicione uma quebra de linha após a chave de abertura e antes da chave de fechamento, exceto em casos de conversão de tipo.
Citações
No WordPress, a regra principal é usar aspas simples para strings, a menos que você esteja avaliando algo dentro delas. Se precisar de aspas dentro de uma string, alterne entre aspas simples e duplas. Escapar as aspas é permitido, mas raramente necessário.
Aparelho ortodôntico
A maneira mais simples é sempre usar chaves. Embora os padrões permitam omitir chaves em instruções "if" de uma única linha sem blocos de várias linhas na mesma estrutura, isso não é permitido em loops de uma única linha. Eu prefiro sempre usar chaves para maior clareza. Além disso, os padrões especificam que a chave de abertura deve ser colocada na mesma linha da instrução inicial, e não abaixo dela como na documentação do PHP.
Formatação de consultas SQL
Ao escrever consultas SQL, lembre-se de usar maiúsculas nas palavras-chave. Consultas complexas devem ser divididas em várias linhas. É importante compreender bem as consultas, especialmente seus aspectos de segurança, que abordaremos mais adiante. Ataques de injeção de SQL ocorrem devido a falhas de segurança no WordPress, permitindo que hackers acessem e manipulem diretamente o banco de dados por trás de um site WordPress.
Convenções de nomenclatura
No código WordPress, evite usar CamelCase para nomes. Funções devem usar letras minúsculas, com sublinhados quando necessário. Nomes de classes devem começar com a primeira letra maiúscula, separadas por sublinhados.
Os nomes dos arquivos devem ser todos em minúsculas, com hífens entre as partes. Se um arquivo contiver uma única classe, nomeie-o de acordo com a classe, precedido por “class-”.
Para maior clareza, use valores de string em vez de booleanos para os argumentos da função. A regra mais importante é que os nomes sejam descritivos. Em um ambiente colaborativo, procure facilitar a compreensão do seu código por todos.
Declarações de comparação
Uma boa prática, não apenas para o WordPress, é sempre colocar a variável no lado direito de uma comparação. Dessa forma, se você esquecer um sinal de igual, isso causará um erro em vez de avaliar como verdadeiro. Se você gosta de usar operadores ternários, é permitido, mas é recomendável verificar se a variável é verdadeira para tornar as coisas mais claras. Uma exceção ocorre ao verificar variáveis não vazias usando !empty().
FORMATAÇÃO HTML
De acordo com o Codex do WordPress, é importante validar todo o código HTML usando o validador W3C. No entanto, um código válido nem sempre significa que seja um bom código, embora haja uma clara relação entre os dois.
Tipo de documento
O WordPress segue a especificação XHTML 1.0 recomendada pelo W3C em 2000. Apesar disso, o tema Twenty Eleven, um tema padrão do WordPress, usa HTML5. Não há nenhum conflito real, pois o HTML5 inclui serialização XML, permitindo o uso de “XHTML5”
Usando aspas
Em HTML, as aspas são usadas principalmente para atributos e seus valores. Você pode escolher aspas simples ou duplas, mas mantenha um padrão consistente. Pessoalmente, eu uso aspas simples sempre que possível, assim como faço em PHP, para manter a consistência. Isso me ajuda a identificar rapidamente casos especiais em uma linha, apenas observando as aspas.
Etiquetas de fechamento
A especificação XHTML exige o fechamento de todas as tags. Elementos vazios precisam ser fechados com uma barra (/) imediatamente antes do último colchete angular (-). Certifique-se de que haja um espaço antes da barra, conforme especificado.
Recuo
Indente seu HTML seguindo as mesmas regras do PHP. Busque uma estrutura lógica na sua indentação. Ao combinar PHP e HTML, indente os blocos PHP de acordo com o fluxo usual de indentação.
FORMATAÇÃO CSS
A formatação CSS envolve a organização e o estilo da apresentação do conteúdo da web, garantindo consistência e legibilidade em diferentes dispositivos e navegadores. Um CSS bem formatado aprimora a estrutura e o apelo visual dos sites, contribuindo para uma melhor experiência do usuário.
Saiba mais: Como remover CSS não utilizado no WordPress?
Indentação e estrutura
Seu CSS deve seguir este esquema geral: escreva cada seletor em uma linha separada, mesmo que esteja listando vários seletores para um conjunto de regras. Além disso, cada par propriedade-valor deve estar em sua própria linha. Coloque a chave de abertura na linha do seletor e a chave de fechamento em uma linha separada com a mesma indentação da linha do seletor de abertura.
Convenções de nomenclatura
Use apenas letras minúsculas. Separe as palavras dentro de um seletor com um hífen. Dê aos seus seletores nomes legíveis para humanos.
Propriedades e Valores
Existem algumas regras importantes para escrever propriedades e valores. Use versões abreviadas das propriedades sempre que possível, exceto ao sobrescrever uma propriedade previamente definida. Use códigos HEX em minúsculas para cores sempre que possível. Se apropriado, use a versão abreviada. Insira um espaço após os dois pontos que seguem uma propriedade. Sempre use caracteres minúsculos, exceto quando um caractere maiúsculo for necessário, como em nomes de fontes e propriedades específicas de fornecedores. Organize as propriedades CSS em ordem alfabética, com exceção das propriedades específicas de fornecedores, que devem sempre preceder suas contrapartes gerais, e das propriedades dimensionais, que devem ser agrupadas. Se a largura e a altura forem especificadas, escreva a largura primeiro.
Comentando
O CSS suporta apenas um tipo de comentário — o estilo de bloco; não há uma notação separada para comentários em linha. Escreva comentários curtos em uma única linha, sem quebra de linha abaixo. Para comentários que abrangem várias linhas, insira uma quebra de linha logo após a sintaxe de abertura e outra logo antes da sintaxe de fechamento. Se você usar comentários para delimitar seções do código, use a seguinte notação:
Utilizando pré-processadores CSS
Usar pré-processadores CSS como SASS e Less facilita muito a vida dos desenvolvedores, mas eles não são isentos de desvantagens. O código gerado por essas ferramentas geralmente é válido, mas não pode ser considerado muito limpo. Uma folha de estilo criada manualmente (e com cuidado) será muito mais legível do que uma gerada automaticamente pelo Less. Depende do que você está fazendo. Se o seu produto for comercial, o objetivo final é uma boa experiência do usuário, com código válido e otimizado. Nesse caso, use a saída do pré-processador como o CSS principal, mas inclua o arquivo original para os desenvolvedores. Embora seu CSS não esteja em conformidade com os padrões do WordPress, incluir o arquivo original ajuda a contornar a situação até que o WordPress se posicione oficialmente. Sacrificar os padrões de codificação CSS para simplificar o processo de desenvolvimento (com o objetivo de uma melhor experiência do usuário) é aceitável. Sacrificar a validade do código, não.
Como você pode contribuir para os padrões de codificação do WordPress?
Código é como escrita – cada um tem seu próprio estilo único. Seu HTML pode ser diferente do meu, meu JavaScript pode ser de dar dor de cabeça, e seu CSS pode ser de uma beleza que vai mudar sua vida. Mas quando se trata de colaborar em um projeto como o WordPress, ter padrões de codificação consistentes é crucial.
Os padrões de codificação do WordPress existem para garantir que qualquer pessoa que contribua para a base de código possa facilmente ler, entender e desenvolver o trabalho de outros. Ao aderir a esses padrões, você está essencialmente falando a mesma língua que os outros colaboradores. É como concordar em usar regras consistentes de gramática e formatação para que todos possam colaborar perfeitamente no mesmo livro.
Se você deseja contribuir para o WordPress, familiarizar-se com os padrões de codificação e segui-los é fundamental. Isso permite que seu estilo de codificação individual se integre perfeitamente à base de código do WordPress.
Conclusões
Seguir os padrões de codificação do WordPress é essencial para manter uma base de código coesa e colaborativa. Essas diretrizes, desenvolvidas pela comunidade WordPress, servem como uma linguagem comum para colaboradores do mundo todo. Ao seguir os padrões para PHP, HTML, CSS, JavaScript e acessibilidade, os desenvolvedores podem garantir que seu código seja consistente, legível e de fácil manutenção.
À medida que o WordPress continua a evoluir, esses padrões de codificação desempenharão um papel crucial na promoção de um ambiente de desenvolvimento harmonioso e eficiente para toda a comunidade.
