Depuração do WordPress: o guia de tudo o que você precisa saber

O elo mais fraco em qualquer projeto de codificação é você . Ou seja, o erro humano quase sempre é uma garantia, que surgirá na forma de bugs e outros problemas. Você não vai querer que nada disso chegue ao seu site ativo, e é por isso que a depuração do WordPress é uma etapa necessária durante o seu projeto.

Na verdade, o WordPress inclui um modo de depuração próprio, que pode ajudar quando você trabalha com a plataforma. Se você combinar isso com seu depurador fora da plataforma, terá um sistema robusto para capturar qualquer coisa que se espreite no escuro.

Nesta postagem, veremos 🔎 depuração do WordPress e mostraremos como configurá-la. Primeiro, porém, veremos como a depuração do WordPress e outros tipos de detecção de bugs diferem. A partir daí, explicaremos por que o WordPress precisa de seu próprio sistema de depuração antes de mostrar como usá-lo.

A diferença entre a depuração do WordPress e a depuração geral do código

Obviamente, o WordPress usa PHP para executar quase tudo sob o capô, assim como muitos outros aplicativos da web. No entanto, a depuração do WordPress pode ser diferente da depuração de código geral devido à sua estrutura e ecossistema específicos.

A principal diferença entre a depuração do WordPress e a depuração geral do código é como você verá os erros. O WordPress exibirá mensagens de erro relacionadas à plataforma no frontend. Por outro lado, a depuração geral do código geralmente ocorre no Terminal ou em seu editor de código dedicado:

Outra diferença é o uso de funções específicas do WordPress para ajudar no processo de depuração. O WordPress fornece seu próprio conjunto de funções que você usará para interagir com o Sistema de gerenciamento de conteúdo (CMS). Elas diferem das funções típicas do PHP e exigirão que você adote uma abordagem específica para usá-las para depuração.

No geral, a diferença entre a depuração do WordPress e a depuração geral do código está na estrutura específica e no ecossistema do WordPress. Como tal, você precisará entender a arquitetura do WordPress, juntamente com o que a plataforma oferece para depurar problemas de forma eficaz.

Por que a depuração do WordPress requer um processo específico

WordPress não usa apenas seu núcleo PHP. Ele também executa PHP externo na forma de temas e plugins. Se você combinar o desenvolvimento de terceiros com a forma como todos eles se conectam, isso poderá introduzir bugs quando você mesclar todo o código. Como tal, o WordPress oferece suas próprias ferramentas de depuração para ajudar a eliminar esses problemas durante o desenvolvimento.

Outra área que você precisa entender (e que afeta por que você precisa de depuração dedicada do WordPress) é o arquivo principal e a estrutura de pastas. A criação de um tema, por exemplo, depende de uma hierarquia de modelo que pode ser importante quando você está realizando uma varredura de linha para encontrar a origem de um erro.

Além disso, o design do WordPress é baseado em uma boa experiência do usuário (UX). O processo dedicado de depuração do WordPress leva em consideração a necessidade de relatórios de erros amigáveis. Em vez de usar rastreamentos de pilha complicados em seu editor de código, o WordPress exibe uma mensagem de erro clara no front-end:

Falando em UX, o WordPress oferece um conjunto de funções personalizadas para ajudar a tornar seu fluxo de trabalho mais eficiente e seguro. Como resultado, o processo de depuração específico do WordPress significa que você precisará entender essas funções e como elas interagem com a plataforma.

No geral, o WordPress possui um ecossistema complexo, com foco em UX e funções personalizadas. Tudo isso requer seu próprio modo de depuração. Na próxima seção, veremos como ativar isso.

Como ativar o modo de depuração do WordPress (e o que isso faz)

Você pode ativar o modo de depuração do WordPress através do arquivo wp-config.php . Temos um guia rápido sobre como fazer isso e não deve levar mais de um minuto. No entanto, existem alguns modos diferentes que você deseja conhecer e usar potencialmente:

• WP_DEBUG . Este é o modo de depuração básico no WordPress. Ele permite a depuração geral dentro da plataforma.
• WP_DEBUG_LOG . Este modo salva todos os erros, avisos e avisos do PHP em um arquivo debug.log no diretório wp-content . É útil para identificar problemas difíceis de encontrar que não aparecem no frontend.
• WP_DEBUG_DISPLAY . Este modo exibe todos os erros, avisos e avisos do PHP no frontend. É útil para identificar problemas com temas e plugins, mas também pode exibir mensagens para elementos que não parecem quebrados. Por exemplo, você frequentemente verá avisos de convenções incorretas de validação de dados.

Essas três funções podem se entrelaçar, então você precisa tomar cuidado para usá-las da maneira ideal e segura. Por exemplo, muitas vezes você desejará ativar WP_DEBUG e WP_DEBUG_LOG para armazenar quaisquer erros no arquivo debug.log . No entanto, se você não desativar WP_DEBUG_DISPLAY , exibir esses erros no front-end seria ruim para o UX.

Você também pode ir além dos comandos básicos e ativar algumas outras constantes que abordamos em outro artigo:

• SCRIPT_DEBUG . Por motivos de desempenho, o WordPress usa arquivos CSS e JavaScript minificados, mas podem ser um pesadelo para depurar. Depois de ativar SCRIPT_DEBUG , o WordPress usará as versões de desenvolvimento não otimizadas dos arquivos.
• SAVEQUERIES . Isso salva todas as consultas do banco de dados em uma matriz, o que pode ajudá-lo a identificar consultas lentas ou ineficientes que afetam o desempenho do seu site.

O WordPress não seria a plataforma que é sem seus plugins. Como tal, existem muitos plugins úteis para ajudar na depuração do WordPress. A seguir, veremos alguns.

Usando plugins de depuração do WordPress durante o desenvolvimento

Os plug-ins devem fazer parte do seu arsenal para ajudar a investigar erros. Na verdade, a documentação oficial do WordPress sobre depuração inclui algumas opções recomendadas.

Por exemplo, Query Monitor lhe dará informações detalhadas sobre as consultas que você executa. Essa é uma maneira fantástica de ajudar a identificar consultas que causam problemas de desempenho.

A barra de depuração adiciona um menu de depuração à barra de administração do WordPress. Isso permite que você acesse informações de depuração em todos os momentos e inclui informações detalhadas sobre erros de PHP, consultas de banco de dados e solicitações de HTTP.

Como o WordPress usa muitas funções e constantes personalizadas, você provavelmente desejará saber se elas são obsoletas. O plug-in Log Deprecated Notices identifica (e registra) qualquer uso de funções, ganchos ou argumentos obsoletos no WordPress. Você usará o plug-in para ajudar a manter seu código atualizado com os padrões mais recentes do WordPress.

No entanto, existem muitos outros plugins que você pode instalar para ajudar na depuração do WordPress. Uma opção fantástica é simplesmente mostrar ganchos:

Este plug-in permite visualizar todos os ganchos executados por uma página. Muitas vezes, será um plug-in obrigatório, porque você pode ver rapidamente quais ganchos do WordPress uma página usa, o que reduzirá sua busca inicial por um bug.

Se você deseja encontrar um plug-in que seja mais uma solução completa, o DebugPress pode ser uma boa escolha:

Este plug-in fornece informações de depuração em tempo real, que incluem erros de PHP, consultas de banco de dados e solicitações de HTTP. Ele também inclui um console em tempo real para monitorar erros do lado do servidor.

Você pode querer semiautomatizar a instanciação inicial do modo de depuração do WordPress. É para isso que serve o excelente plug-in WP Debugging.

Ele permite que você defina os estados padrão para todas as constantes de depuração disponíveis sem a necessidade de abrir o arquivo wp-config.php . Você os alternará por meio de uma rápida ativação e desativação no menu de plugins do WordPress.

Escolhendo plugins de depuração do WordPress

Quando se trata de escolher plug-ins de depuração do WordPress, as métricas de qualidade do plug-in, como o horário da última atualização , são menos preocupantes. Isso ocorre porque eles geralmente executam tarefas que não exigem uma base de código atual constante.

Por exemplo, Log Deprecated Notices teve sua última atualização em 2021. No entanto, apesar disso, ainda é um plugin recomendado para desenvolvedores do WordPress. Como tal, argumentamos que, se o plug-in funcionar como pretendido e não apresentar mais problemas, será bom usá-lo para fins de depuração.

Os benefícios do monitoramento de desempenho de aplicativos (APM)

As ferramentas APM permitem que você monitore o desempenho de aplicativos, o que inclui sites WordPress. As informações detalhadas de desempenho incluem tempos de resposta, taxas de erro e muito mais.

Pode não parecer que as ferramentas de APM e a depuração tenham muito em comum. No entanto, isso pode ajudar a atenuar algum trabalho de depuração, dependendo do cenário. Além do mais, você pode depurar primeiro e depois manter esse desempenho usando o APM.

Quando se trata de depuração do WordPress, as ferramentas APM têm vários benefícios:

• Você pode identificar gargalos de desempenho em seu site WordPress. A análise em tempo real significa que você pode identificar quaisquer problemas que possam estar deixando seu site lento.
• As ferramentas APM podem ajudar a otimizar o desempenho do seu site. Isso permite que você faça melhorias direcionadas e atualize o desempenho geral.
• Ao monitorar as principais métricas de desempenho, você pode identificar quaisquer problemas que possam estar afetando a integridade do seu site.
• As ferramentas APM também podem ajudar a identificar problemas de segurança em seu site WordPress. Ao monitorar o tráfego e a atividade do site, você pode identificar qualquer comportamento incomum ou suspeito que possa indicar um problema de segurança.

Existem algumas ferramentas de APM disponíveis que se adaptam bem ao WordPress. Por exemplo, Kinsta tem sua própria ferramenta APM, enquanto o WP Engine integra o APM da New Relic em seus serviços.

Em geral, as ferramentas APM podem ajudar a melhorar o UX do seu site WordPress e ter um impacto no seu trabalho de depuração. Embora não seja um substituto, o APM pode ajudá-lo a verificar se as correções de bug são ideais e onde você pode melhorar seu código.

Dicas para ajudá-lo com a depuração do WordPress

Nosso foco para esta postagem é a depuração do WordPress. Com isso em mente, ofereceremos seis dicas para ajudá-lo a ter uma melhor sessão de depuração.

1. Comece com uma análise de código estático
2. Apoie-se em suas ferramentas de depuração
3. Classifique cada bug que você encontrar
4. Retroceda e realize pesquisas binárias para procurar todos os bugs possíveis
5. Execute um depurador após cada novo conjunto de códigos
6. Procure resolver problemas em vez de eliminar bugs

1. Comece com uma análise de código estático

Uma análise de código estático é onde você analisa o código sem executá-lo. Seu objetivo é identificar possíveis erros e vulnerabilidades. Você pode fazer isso por meio de uma varredura linha por linha, embora uma ferramenta seja mais eficiente. O PHP CodeSniffer ou o PHP Mess Detector funcionam bem aqui, sendo que o primeiro também faz parte das ferramentas de edição da JetBrains.

Essas ferramentas podem ajudar a identificar violações de padrões de codificação, código não utilizado e outros possíveis problemas que podem afetar o desempenho e a segurança do seu site WordPress. Você geralmente os instalará em seu ambiente de desenvolvimento e os executará em sua base de código. O relatório gerado descreverá quaisquer possíveis problemas. Isso lhe dá uma maneira de identificá-los e corrigi-los.

Começar com uma análise de código estático permite eliminar problemas potenciais pela raiz no início do processo de desenvolvimento. Isso pode ajudar a garantir que seu site WordPress esteja funcionando bem, antes que qualquer problema se torne mais difícil e demorado para corrigir.

2. Confie em suas ferramentas de depuração

Falando em ferramentas de depuração, elas são quase essenciais, independentemente do seu idioma ou plataforma CMS. Isso é especialmente verdadeiro para o WordPress, pois há uma variedade de plugins excelentes para ajudá-lo. No entanto, ferramentas de terceiros fora da plataforma também agregarão valor.

Na maioria dos casos, as ferramentas de depuração fornecerão uma compreensão mais profunda do seu site. Isso permitirá que você tome decisões mais informadas quando se trata de otimizar o desempenho, melhorar a experiência do usuário e aumentar a segurança.

3. Classifique cada bug que você encontrar

Uma tarefa administrativa de rotina com depuração é classificar cada bug encontrado. Isso pode ser útil para identificar a causa raiz de um problema e determinar a melhor correção.

Você deve considerar vários fatores aqui, como a gravidade do problema, o impacto no UX e a complexidade da correção. Por exemplo, você pode usar um sistema de níveis de gravidade, como crítico, principal, secundário ou cosmético. Isso pode ajudar a priorizar quais bugs resolver primeiro, com base em seu impacto na funcionalidade do site e UX.

Outra maneira de classificar bugs é usar categorias como usabilidade, funcionalidade ou segurança. Isso pode ajudar a identificar como o bug afeta áreas específicas do seu site. Por sua vez, isso torna mais fácil determinar a causa raiz do problema e a melhor abordagem para corrigi-lo.

Além do mais, você não precisa de um sistema especial para armazená-los – uma planilha funciona perfeitamente. Você pode até ter um sistema em seu editor de código ou Ambiente de Desenvolvimento Integrado (IDE), como código de cores.

4. Retroceda e realize pesquisas binárias para procurar todos os bugs possíveis

“Backtracking” é onde você refaz suas etapas para identificar onde um bug apareceu primeiro. Você pode examinar as alterações de código recentes, testar bases de código anteriores ou revisar seus logs. Essa é uma boa maneira de simplificar o processo de depuração para garantir que você resolva todos os possíveis problemas.

Da mesma forma, pesquisas binárias podem ser uma técnica útil para depuração do WordPress, especialmente ao lidar com problemas complexos. Isso envolve testar diferentes partes da base de código de maneira sistemática para identificar a localização do bug. Você pode isolar seções específicas do código, executar testes e passar para a próxima seção para restringir ainda mais o problema.

Esta é uma maneira eficiente de identificar bugs e descobrir como corrigi-los. Você provavelmente economizará tempo e esforço em comparação com abordagens de depuração mais aleatórias. Melhor ainda, essa pode ser uma abordagem melhor para bases de código maiores ou problemas mais complexos.

No entanto, uma pesquisa binária requer uma abordagem metódica e organizada para testar e avaliar todos os possíveis problemas. Como tal, a documentação é importante, pois permite reproduzir e corrigir facilmente quaisquer problemas identificados.

5. Execute um depurador após cada novo conjunto de códigos

Assim como salvar suas alterações em intervalos regulares, você também deve adquirir o hábito de executar um depurador após cada conjunto de código completo. Claro, você vai querer certificar-se de que o código funcione como você pretende antes de prosseguir.

Um dos grandes benefícios aqui é como você não terá bugs persistentes por aí. Isso pode ajudar a evitar que os problemas se transformem em bolas de neve e se tornem mais difíceis de corrigir à medida que o desenvolvimento avança.

No entanto, essa abordagem pode consumir tempo, especialmente para grandes bases de código ou problemas não críticos. Por causa disso, você pode limitar a execução de um depurador apenas para alterações críticas de código ou para áreas mais problemáticas de sua base de código.

6. Procure resolver problemas em vez de eliminar bugs

Quando se trata de depuração do WordPress, pode ser útil mudar seu foco de simplesmente “eliminar bugs” para resolver problemas. Isso significa adotar uma abordagem mais proativa para identificar e resolver problemas, em vez de simplesmente reagir aos erros à medida que eles ocorrem.

Para começar, procure a causa raiz do problema e trabalhe para resolver essa causa, em vez de simplesmente corrigir os sintomas imediatos do problema. Isso pode envolver o retrabalho de certas seções da base de código ou a adoção de novas práticas de desenvolvimento para evitar que problemas semelhantes ocorram no futuro.

Essa abordagem pode melhorar a qualidade geral e a confiabilidade de seus projetos, reduzir a probabilidade de problemas futuros e aprimorar o UX. Além disso, essa abordagem pode ajudá-lo a identificar áreas de melhoria em seu processo de desenvolvimento, o que levará a práticas de desenvolvimento mais eficientes e eficazes.

Conclusão 🧐

Em suma, a depuração do WordPress usará a plataforma para relatar erros de código que afetam sua operação. Além disso, você usará alguns plug-ins dedicados na maioria dos casos para alertá-lo sobre problemas. Na verdade, as opções que você obtém para depurar o WordPress podem funcionar lado a lado com suas ferramentas de depuração típicas, como o Xdebug.

A boa notícia é que você não tem um processo de integração desajeitado quando se trata do WordPress. Você pode trabalhar com o arquivo wp-config.php e ativar o depurador (e logar) usando valores booleanos. Isso mostrará qualquer erro associado junto com mais detalhes do que você normalmente obteria. A partir daí, você pode trabalhar para corrigir bugs e deixar seu site mais perto de terminar.

Você tem alguma dúvida sobre a depuração do WordPress ou sobre algum cenário que encontrou? Deixe-nos saber na seção de comentários abaixo!