Como ajudar na depuração de plugins do WordPress

Os desenvolvedores da JoomUnited trabalham sempre para que os seus plugins funcionem da forma mais otimizada possível; claro que, em alguns casos, pode ocorrer algum tipo de falha, por exemplo, uma incompatibilidade gerada por causa de um plugin de terceiros. E o que queremos quando estes tipos de falhas acontecem? Claro que sejam resolvidas rapidamente ...    

Neste artigo, vamos ensinar-lhe como fornecer as informações corretas ao programador para que ele possa compreender e resolver o erro rapidamente. Este artigo será dividido em 3 passos que vamos seguir para fornecer as informações corretas a um programador quando ocorre um problema:

• Ativar o log de depuração
• Instale o plugin de solução de problemas
• Verifique se há erros de javascript

Ativar o sistema de depuração e registo do WordPress

Em primeiro lugar, temos de saber o que é o WP_DEBUG ; Como podemos ver na Wikipedia, “ WP_DEBUG é uma PHP constante (uma variável global permanente) que pode ser usada para ativar o modo "debug" em todo o WordPress. Presume-se que seja falso por defeito e normalmente é definido como verdadeiro no ficheiro wp-config.php em cópias de desenvolvimento do WordPress.”

Como podemos ver, WP_DEBUG é uma constante que, por padrão, está desativada , mas podemos ativá-la temporariamente para fins de depuração. 

Além disso, existe outra constante PHP chamada WP_DEBUG_LOG que nos ajudará a criar automaticamente um arquivo de texto com todos os erros dos seus plugins e é isso que vamos enviar aos desenvolvedores.  

Vamos ensinar-lhe exatamente como podemos ativá-lo e como ficará se houver um erro com o seu plugin, WP Meta SEO será usado para este exemplo, mas pode seguir os mesmos passos para todos os nossos plugins. Neste caso, temos um problema com o WP Meta SEO, poderia ser qualquer problema, então o que vamos fazer é abrir o ficheiro wp-config.php , pode ser feito com o seu software de edição de texto preferido, com o Notepad, Visual Studio Code, Brackets, por exemplo, basta ir e abrir wp-config.php.

O ficheiro está localizado na raiz do seu servidor, onde está instalado o seu site WordPress.

Abra-o com o editor de texto e pressione CTRL + F ou clique em Editar > Localizar… você poderá ver uma caixa onde pode digitar a palavra que deseja encontrar, neste caso, vamos digitar "WP_DEBUG" e pressionar Enter até encontrar:
"define( 'WP_DEBUG', false )"

Agora que estamos nessa linha, remova o “false” e digite true, clique em Enter e, na linha seguinte, copie define( 'WP_DEBUG_LOG', true ); e salve o arquivo; ele deve ficar como na próxima imagem.

Se estas duas linhas forem alteradas, aparecerá um ficheiro chamado “debug.php” em /wp-content/

E pronto… concluímos o primeiro passo, este é um dos ficheiros de que os nossos programadores vão precisar para acelerar o processo de resolução do seu problema. Todos os erros serão monitorizados e registados neste mesmo ficheiro de texto.

Instale o Plugin de Solução de Problemas do WordPress

O plugin Health Check & Troubleshooting é um plugin que permite executar uma verificação de conflitos sem afetar os visitantes normais do seu site, é realmente fácil de usar e instalar, ainda vamos usar WP Meta SEO para este exemplo. Siga estes passos para instalar e executar uma verificação de conflitos com o Health Check & Troubleshooting:  

• Faça login no seu site WordPress, você estará no painel do seu site
• Clique em “Plugins”, na secção à esquerda da sua página
• Clique em “Adicionar novo”
• Escreva “Health Check & Troubleshooting” na barra de pesquisa, como mostrado abaixo

• Clique em “Instalar Agora”, a lista de plugins será carregada automaticamente, procure o correto e clique em “Instalar Agora” e depois em “Ativar”

• Clique em “Estado do site”, no menu à esquerda há uma seção chamada “Ferramentas” Clique nela e depois em “Estado do site”

• Clique no separador “Resolução de problemas” , leia as informações de aviso e clique em “Entrar no modo de resolução de problemas” 

O modo de resolução de problemas desativa automaticamente todos os plugins e alterna para um tema padrão. O modo de resolução de problemas não afeta os visitantes normais do seu website.  

• Reproduza o problema que estava a enfrentar.

No ambiente predefinido, sem plugins ativos e com um tema predefinido, se o problema ocorrer, isso significa que o nosso plugin não está a causar o comportamento inesperado.

• Clique em “Plugins” > “Plugins instalados”

  O menu “Plugins” será expandido, fornecendo-lhe opções adicionais. Clique em “Plugins Instalados”

• Clique em “Ativar durante a resolução de problemas” ao lado de WP Meta SEO

• Reproduza o problema que você estava enfrentando com apenas o WP Meta SEO ativo e um tema padrão, se o problema ocorrer, o problema é causado pelo nosso plugin.

De certa forma, esta é uma boa notícia, porque você já identificou uma parte do problema. Agora é necessário que o desenvolvedor faça login no seu site e corrija o problema antes que lancemos uma nova versão! Caso contrário, repita os passos para ativar o próximo plugin desativado com o qual você consegue reproduzir o erro.

Verificação e depuração de erros de Javascript em plugins do WordPress

Vamos procurar erros de Javascript com a consola do Chrome ou do Firefox. Dependendo do seu navegador, a designação é ligeiramente diferente, mas seguindo o Chrome e o FireFox, vamos chamar-lhe a “Consola”. Para abrir a consola, basta seguir estes passos:  

• Clique com o botão direito do rato em "Inspecionar" na interface do utilizador, em qualquer parte do site.

• Selecione consola, irá abrir as ferramentas de programador no lado direito da página, clique em “Console”

Verifique se há erros, com o console aberto, reproduza o erro que você estava esperando e dê uma olhada no console, os erros são textos vermelhos que descrevem onde está localizado o conflito de javascript

Se você encontrou um erro de JavaScript, por favor tire um screenshot da versão expandida do erro para incluí-lo no seu ticket/post.

Enviar / Partilhar o Seu Relatório de Problemas

Agora que tem todas estas informações, vai ajudar o programador a acelerar o processo, basta reunir todas as informações que recolheu e adicioná-las ao seu ticket/publicação, vamos recordar, os itens são:  

• debug.log
• Anotação com os plugins que causam conflitos
• Uma captura da consola JavaScript com o erro

Se seguir estes passos e nos enviar as informações corretas, o programador poderá fazer um trabalho de depuração mais rápido e agradecemos muito antecipadamente :)    

Crie e compartilhe uma nova conta de usuário do WordPress para fins de suporte

Criar um novo usuário administrador é, por vezes, uma forma rápida de mostrar à equipe de suporte qual é o seu problema. Antes de iniciar esse processo, um rápido lembrete:

• Não armazenamos credenciais antigas depois que o problema é resolvido (por motivos de segurança)
• Recomendamos que remova essas contas de utilizador administrador criadas para fins de suporte
• Todas as informações compartilhadas com a nossa equipe são seguras e permanecerão privadas

Para criar um novo utilizador, primeiro, inicie sessão no seu site de administração. Após iniciar sessão com êxito, estará no painel do WordPress.

Depois, deve ir ao menu esquerdo Menu > Utilizadores.

Depois disso, navegue até a parte superior da tela, clique no botão Adicionar novo ou vá até o botão Adicionar novo no Menu à esquerda.

Em seguida, o formulário Adicionar Novo Usuário aparecerá na sua tela. Há 2 campos obrigatórios para preencher as informações: Nome de usuário, E-mail.

No campo Palavra-passe , pode usar um gerador de palavra-passe aleatória ou definir a sua própria. E pode marcar a opção Enviar notificação ao utilizador se quiser enviar um e-mail ao novo utilizador sobre a sua conta.

Depois, você escolhe um Papel para o usuário na caixa suspensa. Este é um passo importante para definir as permissões dos usuários no seu site. "Administrador" é o nível mais alto e dá ao usuário acesso a todos os recursos do seu site. Você pode definir outros papéis se quiser limitar o acesso do usuário.

Por fim, clique no botão Adicionar novo utilizador na parte inferior. Já está feito, boa sorte!