Construa passo a passo o seu primeiro plugin para o WordPress: desde o básico até o desenvolvimento prático.

Fundamentos do desenvolvimento de plugins para WordPress e preparação do ambiente

Os plugins do WordPress são, essencialmente, um conjunto de arquivos PHP que expandem as funcionalidades principais do sistema através da API fornecida pelo WordPress. Um plugin pode ser tão simples quanto adicionar apenas um pequeno código, ou tão complexo quanto construir um sistema de gestão completo. Antes de começar a programar, é crucial entender sua estrutura básica. Cada plugin deve ter um arquivo principal, que geralmente recebe o mesmo nome do próprio plugin. my-first-plugin.phpO cabeçalho de comentário no topo deste arquivo é essencial para que o WordPress reconheça o plugin.

O ambiente de desenvolvimento é a pedra angular para um trabalho eficiente. Você precisa criar um ambiente de teste local que seja o mais consistente possível com o ambiente online. Recomendamos o uso de pacotes de integração de servidores locais, como XAMPP, MAMP ou Local by Flywheel. Além disso, assegure-se de que seu editor de código ou ambiente de desenvolvimento integrado (IDE) suporte a realce de sintaxe PHP e a depuração, como VS Code, PhpStorm ou Sublime Text. Ative também as funcionalidades relevantes do WordPress no ambiente local.WP_DEBUGOs padrões são extremamente importantes para a identificação de erros durante a fase de desenvolvimento. Você pode utilizá-los no site…wp-config.phpNo arquivo, isso é feito através da definição de…define('WP_DEBUG', true);Para ativá-lo.

Crie o seu primeiro arquivo de plugin.

Vamos começar criando o plugin mais simples possível: um plugin que exibirá uma notificação personalizada no painel de administração do site.

Leitura recomendada Guia de Desenvolvimento de Plugins para WordPress: Crie suas próprias funcionalidades do zero。

Escreva o arquivo principal do plugin e as cabeças de comentários.

Primeiramente, dentro do diretório de instalação do seu WordPress…wp-content/pluginsDentro da pasta, crie uma nova pasta com o nome demy-first-pluginDentro dessa pasta, crie um arquivo PHP com o mesmo nome.my-first-plugin.php。

Hospedagem para sites WordPress da UltraHost

Garantia de reembolso em 30 dias, largura de banda ilimitada e banco de dados, proteção contra DDoS gratuita; desconto de 50% na compra de 3 anos (planos de 4 TB a 10 TB).

página de acesso

Abra este arquivo e insira o seguinte cabeçalho de comentário com as informações padrão do plugin. Essas informações serão exibidas na página de gerenciamento de plugins no painel administrativo do WordPress.

<?php
/**
 * Plugin Name:       我的第一个插件
 * Plugin URI:        https://example.com/my-first-plugin
 * Description:       这是一个学习WordPress插件开发的入门示例。
 * Version:           1.0.0
 * Author:            你的名字
 * Author URI:        https://example.com
 * License:           GPL v2 or later
 * Text Domain:       my-first-plugin
 * Domain Path:       /languages
 */

Após salvar o arquivo, acesse a página “Plugins” no painel de administração do WordPress. Você deve ver “Meu Primeiro Plugin” na lista de plugins. Ative-o agora; embora o plugin ainda não execute nenhuma função, ele foi carregado com sucesso pelo WordPress.

Implementar uma função básica de notificação no backend

Agora, vamos adicionar a primeira funcionalidade para este plugin: exibir uma mensagem de boas-vindas no topo do painel de administração. Vamos usar as funcionalidades disponíveis no WordPress para isso.admin_noticesGancho. No arquivo principal do plugin de antes, abaixo do cabeçalho dos comentários, adicione o seguinte código:

// 在管理后台显示自定义通知
function mfp_show_admin_notice() {
    ?>
    <div class="notice notice-success is-dismissible">
        <p><?php _e( '欢迎使用“我的第一个插件”！', 'my-first-plugin' ); ?></p>
    </div>
    &lt;?php
}
add_action( &#039;admin_notices&#039;, &#039;mfp_show_admin_notice&#039; );

Explicação do código: Criamos um elemento chamado…mfp_show_admin_noticeEssa função gera um código de notificação em HTML que segue o estilo padrão do backend do WordPress. Para usá-la, basta... (O texto foi interrompido; não há informações completas sobre como utilizá-la.)_e()As funções foram criadas para suportar a internacionalização (i18n) no futuro. Por fim, através de…add_action()A função permite que nossa função personalizada seja instalada (ou “montada”) no WordPress.admin_noticesNeste “gancho”. Após salvar o arquivo, atualize a página do backend do WordPress e você verá essa mensagem de sucesso em verde.

Leitura recomendada Guia completo para o desenvolvimento de plugins do WordPress: de iniciante a tutoriais práticos avançados.。

Aprofundar o desenvolvimento das funcionalidades centrais dos plugins

Após dominarmos a estrutura básica, podemos desenvolver funcionalidades mais práticas. Um pedido comum é a adição automática de um texto personalizado no final do conteúdo dos artigos.

Usar filtros para modificar o conteúdo de um artigo

O WordPress disponibiliza uma grande quantidade de “filtros” para modificar vários tipos de dados. Para adicionar texto após o conteúdo de um artigo, vamos usar um desses filtros.the_contentFiltros. Adicione a seguinte nova função no arquivo principal do plugin:

// 在文章内容末尾添加自定义文本
function mfp_append_to_content( $content ) {
    // 确保只在主循环的单篇文章页面执行
    if ( is_single() && in_the_loop() && is_main_query() ) {
        $custom_text = '<div class="my-plugin-footer"><p>Obrigado pela leitura! Este artigo foi apresentado para você por “Meu Primeiro Plugin”.</p></div>';
        $content .= $custom_text;
    }
    return $content;
}
add_filter( 'the_content', 'mfp_append_to_content' );

Esta função recebe o valor original.$contentAtravés de avaliações condicionais, garantimos que o nosso texto HTML personalizado seja adicionado apenas na página do artigo específico e somente quando este estiver sendo processado na consulta principal. Por fim, o conteúdo modificado é retornado. Esse método é não invasivo e não altera o conteúdo original no banco de dados.

hospedagem compartilhada da hosting.com

Alto desempenho com CPUs AMD EPYC, armazenamento SSD NVMe e LiteSpeed, suporte interno especializado 24 horas por dia, 7 dias por semana, medidas de segurança avançadas, incluindo SSL, força bruta, malware e proteção contra DDoS, economia de até 73%

página de acesso

Criar uma página simples de configurações de gerenciamento

Para que os usuários possam personalizar o texto a ser adicionado no final dos artigos, precisamos criar uma página de configurações para o plugin. Isso envolve vários passos: registrar o menu, criar funções de callback para a página e processar os dados do formulário.

Primeiro, useadmin_menuAdicione uma página de menu subordinado ao gancho (hook):

// 添加插件设置菜单到后台
function mfp_add_admin_menu() {
    add_options_page(
        '我的第一个插件设置', // 页面标题
        '我的插件设置',       // 菜单标题
        'manage_options',    // 权限要求
        'my-first-plugin',   // 菜单slug
        'mfp_options_page_html' // 显示页面内容的回调函数
    );
}
add_action( 'admin_menu', 'mfp_add_admin_menu' );

Em seguida, defina a função de callback.mfp_options_page_htmlEste código é usado para renderizar o formulário HTML da página de configurações. Além disso, é necessário utilizar a API de configurações do WordPress para registrar, salvar e recuperar opções de forma segura. Para manter a simplicidade, aqui está uma versão simplificada da implementação:

Leitura recomendada Guia Completo para Desenvolvimento de Plugins para WordPress: Desde o Início até a Construção de Extensões de Nível Profissional。

// 设置页面的HTML内容
function mfp_options_page_html() {
    // 检查用户权限
    if ( !current_user_can( 'manage_options' ) ) {
        return;
    }
    ?>
    <div class="wrap">
        <h1></h1>
        <form action="/pt/options.php/" method="post" data-trp-original-action="options.php">
            <?php
            // 输出设置字段、非ce等安全字段
            settings_fields( 'mfp_options_group' );
            do_settings_sections( 'my-first-plugin' );
            submit_button( '保存设置' );
            ?>
        <input type="hidden" name="trp-form-language" value="pt"/></form>
    </div>
    <?php
}

// 初始化插件设置
function mfp_settings_init() {
    // 注册一个设置
    register_setting( 'mfp_options_group', 'mfp_footer_text' );

// 添加一个设置区域
    add_settings_section(
        'mfp_section',
        '自定义文本设置',
        null,
        'my-first-plugin'
    );

// 向区域中添加字段
    add_settings_field(
        'mfp_field_footer',
        '文章页脚文本',
        'mfp_field_footer_html',
        'my-first-plugin',
        'mfp_section'
    );
}
add_action( 'admin_init', 'mfp_settings_init' );

// 渲染文本输入字段
function mfp_field_footer_html() {
    $option = get_option( 'mfp_footer_text', '感谢阅读！本文由“我的第一个插件”为您呈现。' );
    ?>
    <input type='text' name='mfp_footer_text' value='<?php echo esc_attr( $option ); ?>' class='regular-text'>
    <p class="description">O conteúdo inserido aqui será exibido no final de cada artigo.</p>
    &lt;?php
}

Finalmente, modifique o conteúdo anterior.mfp_append_to_contentFunção para recuperar informações de opções do banco de dados.mfp_footer_textO texto é lido a partir de um arquivo, em vez de usar texto hardcoded (ou seja, texto definido diretamente no código).

Segurança de plugins, otimização e preparação para lançamento

Na última fase do desenvolvimento, é necessário prestar atenção à segurança, à qualidade do código e ao processo de implantação, a fim de garantir que o plugin seja robusto e funcional.

Hospedagem Compartilhada InterServer

Hospedagem compartilhada $2.50 USD por mês, primeiro mês $0.1 USD código promocional tryinterserver, 461 scripts de aplicativos em nuvem, instalação com um clique.

página de acesso

Seguir as melhores práticas de segurança

Todos os dados inseridos pelos usuários devem ser escapados ou verificados antes de serem exibidos no navegador ou armazenados no banco de dados. Ao exibir os dados, use…esc_html()、esc_attr()、esc_url()Funções como essas são utilizadas ao processar o envio de formulários ou solicitações AJAX.wp_verify_nonce()echeck_admin_referer()Para verificar a legitimidade da solicitação e evitar ataques de falsificação de solicitações entre sites (CSRF – Cross-Site Request Forgery), nunca confie diretamente nas informações recebidas.$_GET、$_POSTou$_REQUESTOs dados contidos nisso.

Implementar suporte a internacionalização

Para que o plugin possa ser usado por usuários de todo o mundo, é necessário internacionalizar todas as strings direcionadas aos usuários no código. Já usamos esse método em exemplos anteriores._e()Você precisa criar uma função para exibir o texto traduzido. Além disso, é necessário declarar essa função no cabeçalho dos comentários do plugin.Text DomaineDomain Path。
Durante a inicialização do plugin (por exemplo, através de...)plugins_loaded(Gancho), useload_plugin_textdomain()Função para carregar arquivos de idioma:

function mfp_load_textdomain() {
    load_plugin_textdomain( 'my-first-plugin', false, dirname( plugin_basename( __FILE__ ) ) . '/languages/' );
}
add_action( 'plugins_loaded', 'mfp_load_textdomain' );

Em seguida, você pode usar ferramentas como o Poedit para extrair strings do código-fonte dos plugins.__()， _e()Cadeias de caracteres encapsuladas em funções como `wait()` ou outras semelhantes)..potArquivo de modelo, para que o tradutor possa criá-lo..poe.moDocumentos.

Organização do código e considerações de desempenho

Conforme as funcionalidades dos plugins aumentam, não se deve acumular todo o código no arquivo principal. A abordagem mais sensata é dividir o código em módulos, de acordo com as suas funções, e distribuí-los em arquivos separados..phpOs arquivos estão contidos no documento principal, e eles são incluídos de forma seletiva através deste arquivo principal. Por exemplo, é possível criar…includes/admin/O diretório contém o código relacionado ao backend.includes/public/Armazena o código relacionado à parte front-end (a interface do usuário).includes/class-*.phpArmazena as definições das classes.
Para operações que consomem muitos recursos, considere usar o cache temporário do WordPress (Transients API) para armazenar os resultados de consultas que demoram muito tempo, ou utilize tarefas agendadas (Cron API) para processar tarefas que não são urgentes em segundo plano. Assegure-se de que os plugins, quando desativados, possam ser removidos corretamente através dos ganchos de desinstalação (uninstallation hooks) registrados.register_uninstall_hook()Limpe os dados e opções criados, para manter o site organizado e limpo.

resumos

Através deste tutorial, completamos o processo de construção de um plugin para WordPress, do zero à perfeição. Começamos com o entendimento da estrutura básica de um plugin e a configuração do ambiente de desenvolvimento, criando o arquivo principal que contém as cabeças de comentários padrão. Em seguida, realizamos o processo de montagem (ou “montagem”) do plugin no sistema do WordPress.admin_noticesethe_contentEsses dois ganchos principais permitem a implementação de notificações em segundo plano e a exibição de texto no rodapé dos artigos. Para aumentar a praticidade do plugin, introduzimos ainda a API de configurações do WordPress, criando uma página de gerenciamento que permite aos usuários personalizar o texto exibido. Por fim, abordamos tópicos avançados de extrema importância no desenvolvimento de plugins, como práticas de segurança, suporte a internacionalização e otimização da organização do código. Esse processo ilustra claramente o paradigma central do desenvolvimento de plugins para o WordPress: utilizar os diversos ganchos de ação e filtros para adicionar funcionalidades, seguir as especificações da API para criar interfaces intuitivas, e sempre priorizar a segurança e a manutenibilidade do código. Ao dominar esses conceitos básicos, você estará pronto para explorar um mundo ainda mais rico de plugins.

Perguntas frequentes Perguntas frequentes

Quais são os conhecimentos prévios necessários para desenvolver um plugin para o WordPress?

Você precisa ter uma base sólida em programação PHP, pois o código do plugin é principalmente escrito em PHP. Além disso, é necessário ter um conhecimento básico de HTML, CSS e JavaScript para lidar com a exibição e interação do lado front-end. É essencial estar familiarizado com os conceitos básicos do WordPress, como temas, tipos de artigos, categorias e, em particular, com o sistema de ganchos (Hooks) do WordPress, incluindo ações (Actions) e filtros (Filters).

###
Quais arquivos são essenciais para um plugin básico do WordPress?

No caso mais básico, um plugin pode conter apenas um arquivo PHP. No entanto, esse arquivo deve incluir no início as chamadas de cabeçalho (Plugin Headers) que atendem aos padrões do WordPress, como mostrado no nosso exemplo.Plugin Name、DescriptionEsses campos são a única informação que o WordPress utiliza para reconhecer o plugin e exibi-lo na lista de gerenciamento de plugins.

###
Como devo nomear as funções e variáveis do meu plugin?

Para evitar conflitos com o código do núcleo do WordPress, dos temas ou de outros plugins, todas as funções, classes, variáveis e constantes personalizadas devem ter um prefixo único. Geralmente, é recomendado usar um prefixo relacionado à abreviação ou ao nome simplificado do plugin. Por exemplo, como usado no nosso exemplo…mfp_(Em nome do My First Plugin). Os nomes das classes também devem seguir esta regra e, sempre que possível, utilizar nomes completos e significativos.

###
As tabelas de banco de dados ou opções criadas dentro de um plugin serão removidas após a eliminação do próprio plugin?

Por padrão, não. Se você fizer isso através de…add_option()、update_option()As opções criadas ou os tabelas de dados personalizados permanecerão no banco de dados mesmo que o usuário exclua os arquivos do plugin pelo painel administrativo do WordPress. Para proporcionar uma experiência de desinstalação mais limpa, você deve utilizar…register_uninstall_hook()Uma função para registrar um callback de limpeza, no qual são removidas todas as opções relacionadas aos plugins, tabelas do banco de dados e caches temporários.

###
如何让我的插件兼容更多的WordPress版本？

Evite usar versões muito recentes do PHP ou funções específicas do WordPress no seu código. Antes de utilizar uma função, classe ou hook, consulte a documentação oficial para saber em que versão do WordPress ela foi introduzida. Isso pode ser feito adicionando comentários no cabeçalho do arquivo principal do seu plugin.Requires at least:A declaração do campo indica a versão mínima do WordPress suportada. No código, isso pode ser combinado com instruções condicionais para garantir que a funcionalidade esteja disponível apenas em versões mais recentes do WordPress.function_exists()ouclass_exists()Verifique para fornecer uma solução de downgrade ou uma dica amigável.