Um guia sobre como melhorar os padrões de codificação do WordPress
Se você é um desenvolvedor, então definitivamente está procurando melhorar seus padrões de codificação. Cada linguagem de programação e seus CMS / Frameworks definiram seus próprios padrões de codificação. Neste artigo, estudamos como melhorar os padrões de codificação do WordPress.
Escrevemos um artigo sobre como melhorar os padrões de codificação do PHP. Você deve primeiro verificar este artigo antes de prosseguir para os padrões de codificação para o desenvolvimento do WordPress.
Erros que estamos cometendo durante a programação do WordPress
Cada trabalho de desenvolvimento tem soluções diferentes. Provavelmente, cada desenvolvedor implementa uma forma / lógica diferente para fornecer a mesma saída. É natural no mundo da programação.
Por exemplo, digamos que adicionamos nonce em nosso formulário de inscrição para evitar ataques CSRF.
<form method="post">
<?php wp_nonce_field( 'signup_nonce', 'signup_form_nonce' ); ?>
</form>Ao enviar um formulário, temos que verificar se o nonce está correto ou não. Normalmente, um desenvolvedor que não conhece os padrões de codificação o faz da seguinte maneira.
<?php
if (! isset( $_POST['signup_form_nonce']) ||! wp_verify_nonce( $_POST['signup_form_nonce'], 'signup_nonce')) {
print 'Sorry, your nonce did not verify.';
exit;
} else {
// process form data
}
?>Não há nada de errado no código acima. Mas, não é uma boa prática. Ao recuperar os valores do campo de texto, devemos usar as funções sanitize_text_field()e wp_unslash()nos valores do campo de entrada.
O método sanitize_text_field executa o seguinte processo em segundo plano.
- Verifica se há UTF-8 inválido
- Converte <caracteres únicos em entidade
- Remove todas as tags
- Remova quebras de linha, tabulações e espaço em branco extra
- Tira octetos
O método wp_unsplash remove barras de uma string ou matriz de strings.
Dito isso, nosso código anterior deve gostar abaixo.
<?php
if (! isset( $_POST['signup_form_nonce']) ||! wp_verify_nonce( sanitize_text_field( wp_unslash( $_POST['signup_form_nonce']) ), 'signup_nonce')) {
print 'Sorry, your nonce did not verify.';
exit;
} else {
// process form data
}
?>Este é um exemplo. Existem vários outros erros que estamos cometendo em nossa programação WordPress.
Instale a biblioteca de padrões de codificação do WordPress
Esta biblioteca nos ajudará a melhorar nossos padrões de codificação no desenvolvimento de WordPress e nos estabelecer como um desenvolvedor de WordPress melhor.
Para instalar esta biblioteca, abra o prompt de comando no diretório raiz de um projeto e execute o comando abaixo.
composer create-project wp-coding-standards/wpcs --no-dev
Nota: Você deve ter o composer instalado em seu sistema para executar o comando acima.
Depois de executar o comando, ele criará uma pasta chamada ‘wpcs’ no diretório raiz de um projeto.
Presumimos que você leu nosso artigo sobre melhoria dos padrões de codificação do PHP e instalou a biblioteca PHP_CodeSniffer dentro da pasta ‘php_codesniffer’ no diretório raiz do projeto.
Em seguida, precisamos registrar os padrões do WordPress na configuração do PHP_CodeSniffer. Abra o prompt de comando em ‘php_codesniffer / vendor / bin’ e execute o comando abaixo.
phpcs --config-set installed_paths /path/to/wpcs
Substitua ‘/ path / to / wpcs’ pelo seu caminho. No nosso caso, na plataforma Windows, escrevemos o comando da seguinte maneira.
phpcs --config-set installed_paths D:wampwwwwp1wpcs
Vamos descobrir nossos erros e melhorar os padrões de codificação do WordPress
Estabelecemos com nossa biblioteca. Agora, é hora de encontrar nossos erros e evitá-los na próxima vez.
Digamos que criamos um plugin ‘test-plugin’ e temos que validar um arquivo chamado ‘core.php’.
Abra o prompt de comando no diretório ‘wpcs / vendor / bin’ e execute o comando abaixo.
phpcs --standard=WordPress D:wampwwwwp1wp-contentpluginstest-plugincore.php
Depois de executar o comando, você irá avisar com os erros e avisos. Todos esses erros e avisos aparecem porque não seguimos as práticas de codificação padrão para o desenvolvimento do WordPress.
Uma boa parte é que obtemos o relatório detalhado sobre os números das linhas e como corrigir esse erro específico. Precisamos apenas examinar as diretrizes e corrigir os erros um por um.
phpcbf comando também pode corrigir alguns erros menores, como indentação, espaços etc.
phpcbf --standard=WordPress D:wampwwwwp1wp-contentpluginstest-plugincore.php
Esperamos que você entenda como usar a biblioteca de padrões de codificação do WordPress para melhorar os padrões de codificação do WordPress. Se você tiver alguma dúvida ou sugestão, por favor, deixe um comentário abaixo.