Guia de estilo de código

É importante manter o código legível e de fácil manutenção. Isso previne que pequenos erros, tornem-se críticos a ponto de você perder horas de trabalho, para perceber que esqueceu de adicionar um “;” na Linha X. É recomendável usar o mesmo “Code Standard” ao decorrer de toda a sua aplicação. Mas se você se sente mais confortável, usando o padrão PSR, não há problema algum nisso, com tanto que a use de maneira consistente.

Indentação

Indentação no WordPress é feito usando “tabs”, representado por 4 espaços. Indentação é muito importante para um código mais legível, e cada declaração deve estar em sua própria linha. Sem a indentação, fica mais díficil de entender o código, e os erros tornam-se mais frequentes.

Dê uma olhada em Editor Config. Ele é uma ótima maneira de assegurar de que todos os membros do time, estão seguindo UM mesmo padrão.

O seguinte arquivo .editorconfig reforça as regras acima, com indentação de largura de 4 espaços.

  1. [*.php]
  2. indent_style = tabs
  3. indent_size = 4

Tag Spam do PHP

As tags <?php and ?> devem ser usadas separadamente. Por exemplo:

  1. <?php // bad ?>
  2. <?php while( have_posts() ) { ?>
  3.     <?php the_post(); ?>
  4.     <?php the_title(); ?>
  5.     <strong><?php the_date(); ?></strong>
  6.     <?php the_content(); ?>
  7. <?php } ?>

Seria mais fácil de ler:

  1. <?php
  2. // good
  3. while( have_posts() ) {
  4.     the_post();
  5.     the_title();
  6.     ?>
  7.     <strong><?php the_date(); ?></strong>
  8.     <?php
  9.     the_content();
  10. } ?>

Linting

Muitos editores suportam ou já possuem um verificador de sintaxes. Esses verificadores são chamados de Linters, quando usado com um bom editor, erros de sintaxe são destacados e depurados mais facilmente. Por exemplo, no PHPStorm, é dado a um erro de sintaxe um destaque vermelho.

Padrões do WordPress

WordPress segue um conjunto de padrões. Esses padrões são diferentes do padrão PSR. Por exemplo, WordPress usa tabs ao invés de espaços, e abre os parentêses em uma nova linha.

O Manual do WordPress para contribuidores, aborda os padrões de código, mais detalhadamente. Abaixo estão algumas referências para estudo.

PHP Code Sniffer & PHP CS Fixer

O PHP Code Sniffer é uma ferramente responsável por verificar violações no código. Atualmente muitos editores, trazem com eles essa função. E o PHP CS Fixer, corrigi automaticamente essas violações para você.

Para usar essas ferramentas, você precisará da definição dos Padrões de Código do WordPress. Você pode encontra-los aqui, junto com as instruções do PHPStorm