Limpar um trecho de PHP

Por que a formatação ajuda quem lê

As pessoas leem código pelo formato. Quando as chaves ficam alinhadas e cada instrução tem sua própria linha, o leitor percebe a estrutura antes de ler qualquer palavra. Assim, um revisor consegue notar uma chave que falta ou um laço no lugar errado. Um bloco de texto corrido esconde tudo isso.

Antes e depois

Original, copiado de um log:

<?php function total($items){$sum=0;foreach($items as $item){$sum+=$item["price"];}return $sum;}

Organizado com 4 espaços:

<?php function total($items)
{
    $sum=0;
    foreach($items as $item)
    {
        $sum+=$item["price"];
    }
    return $sum;
}

Lista de verificação antes de postar

• Remova dados sensíveis. O texto colado aqui é processado no nosso servidor, então não use credenciais reais, tokens nem dados de clientes.
• Mantenha o exemplo mínimo, com apenas as linhas necessárias para mostrar o problema.
• Informe a versão do PHP que você usa e o que você esperava que acontecesse.
• Compare o código formatado com o original. A ferramenta altera apenas o layout, mas as regras de espaços em branco podem afetar comentários e strings.
• Coloque o resultado dentro de um bloco de código para que a indentação seja preservada.

O que esta ferramenta não faz

Ela não encontra erros, não executa seu código e não verifica regras de estilo. Um layout limpo facilita ver um problema, mas não o resolve.

Onde isso ajuda

• Um chamado de suporte ou um relatório de bug que inclui um exemplo de código.
• Uma pergunta em um fórum de desenvolvedores ou em um canal de chat.
• Uma página de documentação ou um tutorial em que um exemplo precisa parecer organizado.
• Um comentário de revisão em que você sugere uma mudança em parte de uma função.

Em todos esses casos, quem lê vê primeiro a estrutura e depois o problema, que é a ordem desejada.

Mantenha o trecho fiel

Formate o código que você realmente vai postar, e não uma versão reescrita mais limpa. Se você encurtar nomes de variáveis ou remover linhas para o exemplo caber, execute você mesmo a versão encurtada antes. Um trecho bonito que não reproduz o problema só faz o leitor perder tempo. Se você incluir uma nota sobre o resultado esperado, coloque-a acima do bloco de código, com palavras simples.