Theme Update Checker é uma biblioteca de verificação de atualização personalizada para temas do WordPress. Esta ferramenta permite adicionar notificações de atualização automática e atualizações com um clique para seus temas privados. Basta fornecer os detalhes do seu tema no arquivo style.css
, e a biblioteca se encarregará de verificar periodicamente a URL para novas versões, exibindo uma notificação ao usuário quando necessário.
A interface de atualização utilizada é a padrão do WordPress, proporcionando uma experiência familiar para os usuários.
- Notificações Automáticas: Alerta os usuários sobre novas versões disponíveis.
- Atualizações com um Clique: Facilita a atualização dos temas diretamente do painel do WordPress.
- Fácil Integração: Simples de configurar e usar com qualquer tema do WordPress.
Adicione o seguinte código ao seu wp-config.php
:
define('GITHUB_AUTH_TOKEN', 'seu-novo-token-aqui');
No arquivo functions.php
do seu tema, inclua a biblioteca:
require get_template_directory() . '/theme-update-checker/theme-update-checker.php';
Adicione as seguintes linhas ao seu functions.php
:
$github_username = 'seu-usuario'; // Nome do usuário do github.com
$repository_name = 'seu-repositorio'; // Repositório usado para hospedar os arquivos do tema
add_theme_update_hooks($github_username, $repository_name, GITHUB_AUTH_TOKEN);
// Caso não queira definir GITHUB_AUTH_TOKEN no wp-config.php, você pode adicionar seu token diretamente no código:
// add_theme_update_hooks($github_username, $repository_name, 'seu-novo-token-aqui');
Para que a biblioteca funcione corretamente, é necessário criar releases e associar tags no seu repositório do
GitHub. Siga os passos abaixo:
- Vá para a página do seu repositório no GitHub.
- Clique na aba
Releases
na parte superior. - Clique no botão
Draft a new release
. - Preencha os campos:
- Tag version: A tag correspondente à versão do seu tema, por exemplo, v1.0.0.
- Release title: Um título descritivo para a release.
- Description: Descrição detalhada das mudanças nesta versão.
- Faça upload do arquivo
zip
do seu tema no campo "Attach binaries by dropping them here or selecting them". - Clique em
Publish release
.
No arquivo style.css
do seu tema, certifique-se de que a versão do tema está corretamente definida. Por exemplo:
/*
Theme Name: Nome do Tema
Theme URI: http://seudominio.com
Author: Seu Nome
Author URI: http://seudominio.com
Description: Descrição do tema.
Version: 1.0.0
License: GNU General Public License v2 or later
License URI: LICENSE.txt
Text Domain: seutema
*/
Utilize a função debug_theme_update_process
para verificar se o processo de atualização está funcionando corretamente:
debug_theme_update_process(update_theme_from_github($github_username, $repository_name, GITHUB_AUTH_TOKEN));
Este projeto está licenciado sob a Licença MIT.
Contribuições são bem-vindas! Por favor, leia o guia de contribuição para obter mais detalhes sobre como enviar solicitações pull, relatar problemas, etc.