O WordPress é um dos sistemas de gerenciamento de conteúdo (CMS) mais populares do mundo. Um dos melhores recursos do WordPress é a capacidade de criar seus próprios plugins e, assim, personalizar e estender a funcionalidade do seu site como desejar. Nesta postagem do blog, darei a você um guia detalhado sobre como criar um plugin do WordPress que integre vários recursos, tenha sua própria página de administração e ofereça recursos completos de ativação e desativação.
Etapa 1: Entenda os princípios básicos do plugin
Antes de começarmos com o desenvolvimento propriamente dito, precisamos entender os conceitos básicos de um plugin do WordPress. Um plugin é essencialmente uma coleção de arquivos PHP que são colocados no diretório do WordPress wp-content/plugins
ser carregado. Ele amplia a funcionalidade do seu site e pode executar diversas tarefas, desde personalizar o tema até adicionar novos recursos.
Etapa 2: Criar estrutura de plugin
Vamos começar criando a estrutura básica do nosso plugin. Crie uma nova pasta em wp-content/plugins
e nomeie-o como “meu-plugin”. Nesta pasta você cria um arquivo principal chamado meu-plugin.php
. Este arquivo é carregado quando o plugin é ativado e contém o código que inicializa as funções do plugin.
<?php /* Plugin Name: Mein WordPress Plugin Description: Ein tolles Plugin für deine Website. Version: 1.0 Author: Dein Name */ // Hier beginnt der Plugin-Code ?>
Etapa 3: Adicionar recursos
Agora vamos adicionar algumas funções de exemplo. Suponha que queremos adicionar um botão personalizado ao editor do WordPress para inserir conteúdo especial. Aqui está um exemplo simples:
function mein_plugin_button($buttons) { array_push($buttons, "mein_plugin_button"); return $buttons; } function mein_plugin_button_action($content) { return $content . "<p>Hallo, das ist mein Plugin!</p>"; } add_filter('mce_buttons', 'mein_plugin_button'); add_filter('mce_external_plugins', 'mein_plugin_button_action');
Se você deseja ter vários recursos em seu plugin, há algumas coisas que você deve prestar atenção:
1. Exclusividade dos nomes das funções: Evite usar nomes genéricos para suas funções, pois eles podem entrar em conflito com outros plugins ou temas. Em vez disso, use prefixos para garantir que sejam únicos (por exemplo meuplugin_minha_função()
).
2. Ordem e estrutura: Organize seu código agrupando funções relacionadas em arquivos ou seções separadas do seu arquivo principal. Isso torna seu código mais claro e fácil de manter.
3. Comentários: Comente seu código, especialmente se ele for complexo ou pouco claro. Isso ajudará você e outros desenvolvedores a entender o código mais tarde.
4. Use ações e filtros: Em vez de alterar o código principal do WordPress diretamente, use ações e filtros para fazer alterações. Isso garante que seu plugin permaneça compatível com futuras atualizações do WordPress.
5. Verificação da existência de funções: Se o seu plugin depende de certos recursos que podem ser adicionados ou removidos em versões posteriores do WordPress, sempre verifique primeiro se esse recurso existe antes de chamá-lo:
if (function_exists('die_funktion')) { die_funktion(); }
6. Teste: Antes de lançar seu plugin, você deve testá-lo completamente, especialmente em combinação com outros plugins e temas populares, para garantir que não haja conflitos ou efeitos colaterais indesejados.
Etapa 4: Crie sua própria página de administração (opcional)
Outro caso de uso comum para plugins é criar sua própria página de administração. Aqui está um exemplo simples de como você pode fazer isso:
function mein_plugin_admin_page() { add_menu_page( 'Mein Plugin Einstellungen', 'Mein Plugin', 'manage_options', 'mein-plugin-admin', 'mein_plugin_admin_page_callback' ); } function mein_plugin_admin_page_callback() { echo '<div class="wrap">'; echo '<h2>Mein Plugin Einstellungen</h2>'; // Hier kannst du den Inhalt deiner Administrationsseite einfügen. echo '</div>'; } add_action('admin_menu', 'mein_plugin_admin_page');
4.1. A função meu_plugin_admin_page()
criar
Primeiro criamos uma função chamada meu_plugin_admin_page()
. Esta função é usada para adicionar a página de administração do nosso plugin. O adicionar_página_menu()
A função é usada para adicionar um item de menu na interface de administração do WordPress.
function mein_plugin_admin_page() { add_menu_page( 'Mein Plugin Einstellungen', // Seitentitel in der Menüleiste 'Mein Plugin', // Anzeigename im Menü 'manage_options', // Benutzerrolle, die Zugriff hat (hier: Administratoren) 'mein-plugin-admin', // Eindeutiger Seiten-Slug 'mein_plugin_admin_page_callback' // Callback-Funktion zum Rendern der Seite ); }
'Minhas configurações de plugin'
é o título que aparece na barra de menu da administração do WordPress.
'Meu Plugin'
é o nome de exibição no menu.
'gerenciar_opções'
especifica que somente usuários com a função de Administrador têm acesso a esta página.
'meu-plugin-admin'
é um slug exclusivo para sua página de administração.
'minha_página_de_administração_do_plugin_retorno_de_chamada'
é a função de retorno de chamada que é chamada para criar o conteúdo da página de administração.
4.2. A função de retorno de chamada meu_plugin_admin_page_callback()
criar:
A função de retorno de chamada meu_plugin_admin_page_callback()
é chamado para criar o conteúdo da página de administração. Aqui você pode adicionar todas as configurações e opções para seu plugin. Por exemplo:
function mein_plugin_admin_page_callback() { echo '<div class="wrap">'; echo '<h2>Mein Plugin Einstellungen</h2>'; // Hier kannst du den Inhalt deiner Administrationsseite hinzufügen. echo '</div>'; }
'<div class="wrap">'
é usado para envolver o conteúdo da página e aplicar o estilo padrão do WordPress.
'<h2>Minhas configurações de plugin</h2>'
é o título da página de administração. Você pode personalizar este título como quiser.
Na linha // Aqui você pode adicionar o conteúdo da sua página de administração.
você pode adicionar formulários HTML personalizados, campos de entrada e opções para controlar as configurações do seu plugin.
4.3. Adicione a página de administração
Para adicionar sua página de administração, vá para meu_plugin_admin_page()
função e anexá-la à ação menu_administrador
. Isso geralmente acontece no arquivo principal do seu plugin.
add_action('admin_menu', 'mein_plugin_admin_page');
Esta linha garante que a função meu_plugin_admin_page()
é chamado quando o menu de administração do WordPress é criado. Isso tornará seu plugin visível na interface de administração do WordPress.
4.4. página de teste
Agora você pode ativar seu plugin e testar a página de administração. Acesse o painel do WordPress, clique no item de menu “Meu plugin” (ou no nome de exibição escolhido) e você será levado para a página de administração, onde poderá adicionar suas configurações e recursos.
Criar sua própria página de administração permite que os usuários personalizem a configuração do seu plugin e torna a experiência geral do usuário mais amigável. Você pode usar esta página para adicionar opções, configurações ou outro conteúdo específico do plugin que você deseja que os usuários gerenciem.
Etapa 5: Gerenciar ativação e desativação (opcional)
Seu plugin também deve oferecer a opção de ser ativado e desativado. Isso é feito adicionando funções de ativação e desativação no arquivo principal do seu plugin:
register_activation_hook(__FILE__, 'mein_plugin_activate'); register_deactivation_hook(__FILE__, 'mein_plugin_deactivate'); function mein_plugin_activate() { // Hier kannst du Initialisierungsaktionen durchführen, wenn das Plugin aktiviert wird. } function mein_plugin_deactivate() { // Hier kannst du Bereinigungsaktionen durchführen, wenn das Plugin deaktiviert wird. }
Etapa 6: Instale o plugin finalizado
Depois de terminar de programar seu plugin e desejar integrá-lo à sua instalação do WordPress, siga estes passos:
1. Compilar arquivos de plugin
- Seu plugin deve ter um arquivo principal que contém os metadados do plugin, como nome do plugin, versão, autor, etc. Esses metadados serão exibidos na área de administração do WordPress.
- Organize todos os arquivos e diretórios relacionados ao seu plugin em uma pasta separada.
2. Crie um arquivo ZIP
- Compacte a pasta com seu plugin em um arquivo ZIP. Isso facilita o upload e a instalação no WordPress.
3. Instale o plugin no WordPress
Instalação manual através do painel do WordPress
3.1. Na área de administração do WordPress, vá em “Plugins” > “Instalar”.
3.2. Clique em “Upload Plugin” e selecione o arquivo ZIP que você criou anteriormente.
3.3. Clique em “Instalar agora”.
3.4. Após a instalação bem-sucedida, clique em “Ativar plugin”.
Instalação manual via FTP
3.1. Descompacte o arquivo ZIP no seu computador.
3.2. Use um cliente FTP (por exemplo, FileZilla) para se conectar ao seu servidor web.
3.3. Navegue até o diretório wp-content/plugins/
sua instalação do WordPress.
3.4. Carregue a pasta do seu plugin para este diretório.
3.5. Na sua área de administração do WordPress, vá em “Plugins”, encontre seu plugin na lista e clique em “Ativar”.
4. Teste
- Depois de ativar o plugin, você deve testar sua funcionalidade no seu site. Certifique-se de que tudo funciona conforme o esperado e que não há conflitos com outros plugins ou com o tema.
5. Atualizações e Manutenção
- Sempre que fizer atualizações no seu plugin, incremente o número da versão no cabeçalho de metadados do plugin.
- Depois de ter uma nova versão, você pode reempacotar o plugin e atualizá-lo por meio do painel. Alguns desenvolvedores também usam sistemas de gerenciamento de atualizações para fornecer atualizações para seus plugins.
Etapa 7: publicar plugin (opcional)
Se você quiser que outros usuários possam usar seu plugin, você pode publicá-lo no [Repositório de Plugins do WordPress](https://wordpress.org/plugins/) oficial. Para fazer isso, você precisa criar uma conta SVN, enviar seu plugin para revisão e seguir as diretrizes de desenvolvimento de plugins do WordPress.
Não se esqueça de fazer backup do seu site regularmente, especialmente antes de instalar novos plugins ou atualizá-los, para evitar possíveis perdas de dados.
Conclusão
Criar um plugin do WordPress pode parecer complexo no começo, mas com uma estrutura clara e este guia passo a passo, você pode desenvolver seus próprios plugins com facilidade. Lembre-se de que a segurança e o desempenho devem ser sempre sua principal prioridade ao criar plugins.