Guia Completo para Desenvolvimento de Plugins para WordPress: Construa o Seu Próprio Plugin do Zero

Preparativos antes do desenvolvimento

Antes da codificação, uma preparação adequada é uma pedra angular essencial para o sucesso do projeto. Você precisa criar um ambiente de desenvolvimento eficiente e seguro.

Criar um ambiente de desenvolvimento e teste local

É fortemente recomendado não desenvolver plugins em servidores de produção. Utilizar um ambiente de desenvolvimento local permite que você experimente novas funcionalidades sem preocupações com a possibilidade de o site falhar. Você pode usar ferramentas como XAMPP, MAMP, Local by Flywheel ou Docker para configurar rapidamente um ambiente de execução do WordPress no seu computador, incluindo Apache/Nginx, MySQL e PHP. Dessa forma, as modificações e o depuramento do código serão muito mais eficientes.

Compreender a estrutura básica dos plugins do WordPress

Um dos plugins mais simples para o WordPress pode conter apenas um arquivo principal. Esse arquivo principal deve ter uma específica anotação no início (header comment), que serve para informar o WordPress sobre as informações básicas do plugin. Por exemplo, um plugin chamado…my-first-plugin.phpO conteúdo do arquivo pode ser exibido da seguinte forma:

Leitura recomendada Guia Completo para Desenvolvimento de Plugins para WordPress: Construa o Seu Primeiro Plugin Funcional do Zero。

<?php
/**
 * Plugin Name:       我的第一个插件
 * Plugin URI:        https://example.com/my-first-plugin/
 * Description:       这是一个用于演示的简单插件。
 * Version:           1.0.0
 * Author:            你的名字
 * License:           GPL v2 or later
 * Text Domain:       my-first-plugin
 */

Coloque este arquivo em…/wp-content/plugins/No diretório correspondente, você poderá ver e ativar o plugin na página “Plugins” do painel administrativo do WordPress. Esta é a forma mais básica de um plugin; no entanto, ele ainda não possui nenhuma funcionalidade.

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

Construa o seu primeiro plugin funcional.

Vamos começar com um exemplo prático para criar um plugin que adiciona automaticamente os direitos autorais no final de um artigo. Esse exemplo ilustrará vários conceitos fundamentais do plugin.

Definir a função principal do plugin

Precisamos criar uma função para gerar e exibir informações de copyright. Vamos chamá-la de…myplugin_add_copyright_textEssa função obtém as informações do artigo atual e as combina em um texto de declaração de direitos autorais.

function myplugin_add_copyright_text( $content ) {
    if ( is_single() ) {
        $current_year = date( 'Y' );
        $copyright_text = '<p class="myplugin-copyright">© ' . $current_year . ' Todos os direitos reservados. Este artigo foi publicado pela primeira vez no meu site.</p>';
        $content .= $copyright_text;
    }
    return $content;
}

Use ganchos (hooks) para integrar funcionalidades ao WordPress.

Funções isoladas não são executadas automaticamente. Precisamos utilizar os “ganchos de filtro” (Filter Hooks) do WordPress para “acoplar” a nossa função antes que o conteúdo do artigo seja exibido. Aqui, vamos usar…the_contentEste filtro.

add_filter( 'the_content', 'myplugin_add_copyright_text' );

Combine o cabeçalho do arquivo acima com esses dois trechos de código em um único arquivo.phpNo arquivo, um plugin com funcionalidades básicas foi desenvolvido. Ele adiciona uma seção com informações de copyright contendo o ano atual após o corpo de um único artigo.

Leitura recomendada Do zero ao um: Introdução ao desenvolvimento de plugins do WordPress e guia das melhores práticas。

Adicionar um estilo básico ao conteúdo de saída.

Para tornar as informações de copyright mais atraentes visualmente, podemos adicionar alguns estilos CSS simples a elas. A melhor prática é fazer isso de forma organizada e consistente, seguindo diretrizes de design bem estabelecidas.wp_enqueue_styleUma função para enfileirar o carregamento dos arquivos de estilo, garantindo que eles sejam carregados apenas quando necessário. Precisamos criar um arquivo de estilo.style.cssE registre-o no arquivo principal do plugin.
Adicione o seguinte no arquivo do plugin principal:

function myplugin_enqueue_styles() {
    wp_enqueue_style( 'myplugin-style', plugins_url( 'css/style.css', __FILE__ ) );
}
add_action( 'wp_enqueue_scripts', 'myplugin_enqueue_styles' );

Em seguida, crie um novo arquivo no diretório dos plugins.css/style.cssArquivo, e adicione estilos:

.myplugin-copyright {
    font-size: 0.9em;
    color: #666;
    border-top: 1px solid #eee;
    padding-top: 10px;
    margin-top: 20px;
}

Implementar opções de configuração para o plugin

Um plugin maduro geralmente permite que os usuários façam algumas configurações personalizadas. Vamos adicionar uma página de configurações no backend para o plugin de direitos autorais, para que os usuários possam modificar o texto relacionado aos direitos autorais.

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 de menu para configurações do backend

Primeiramente, precisamos adicionar um novo item de menu no menu “Configurações” do painel de administração do WordPress. Isso será feito utilizando…add_options_pageFunção.

function myplugin_add_settings_page() {
    add_options_page(
        '版权插件设置', // 页面标题
        '版权设置',     // 菜单标题
        'manage_options', // 权限
        'myplugin-settings', // 菜单slug
        'myplugin_render_settings_page' // 用于输出页面内容的回调函数
    );
}
add_action( 'admin_menu', 'myplugin_add_settings_page' );

Configurações de registro, blocos e campos

O WordPress disponibiliza a API Settings para gerenciar opções de forma segura e conveniente. Precisamos registrar um grupo de configurações, uma opção de configuração específica (que será armazenada no banco de dados) e um campo (uma caixa de entrada no formulário).

function myplugin_register_settings() {
    register_setting( 'myplugin_settings_group', 'myplugin_copyright_text' );
    add_settings_section( 'myplugin_main_section', '主要设置', null, 'myplugin-settings' );
    add_settings_field( 'myplugin_text_field', '版权文本', 'myplugin_render_text_field', 'myplugin-settings', 'myplugin_main_section' );
}
add_action( 'admin_init', 'myplugin_register_settings' );

// 渲染文本字段的函数
function myplugin_render_text_field() {
    $option_value = get_option( 'myplugin_copyright_text', '© [year] 版权所有。本文首发于我的网站。' );
    echo '<input type="text" name="myplugin_copyright_text" value="' . esc_attr( $option_value ) . '" class="regular-text" />'echo '<p class="description">Você pode usar placeholders. <code data-no-auto-translation="">[year]</code> É usado para representar o ano atual.</p>';
}

Dentre eles,myplugin_render_settings_pageA função é responsável por gerar a estrutura do formulário HTML de toda a página de configurações.

Leitura recomendada Guia completo para o desenvolvimento de plugins do WordPress: construir funcionalidades personalizadas do zero。

Modifique a função principal para suportar texto dinâmico.

Agora, precisamos modificar a função principal original.myplugin_add_copyright_textDeixe que ele leia o texto definido pelo usuário do banco de dados e substitua os placeholders.

function myplugin_add_copyright_text( $content ) {
    if ( is_single() ) {
        $text = get_option( 'myplugin_copyright_text', '© [year] 版权所有。本文首发于我的网站。' );
        $text = str_replace( '[year]', date( 'Y' ), $text );
        $copyright_text = '<p class="myplugin-copyright">'. $text '.'</p>';
        $content .= $copyright_text;
    }
    return $content;
}

A publicação e manutenção de plugins

Após a conclusão do desenvolvimento e os testes, você provavelmente desejará compartilhar sua obra com mais pessoas, o que envolve a compactação do código, a publicação do produto e as atualizações subsequentes.

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

Package and release the content in accordance with the established standards.

Noswp-content/plugins/Dentro do diretório, seu plugin deve estar localizado em uma pasta separada, por exemplo:my-first-plugin/Este diretório geralmente contém, no mínimo, o arquivo do plugin principal.my-first-plugin.phpUmREADME.txt(Descrição do plugin e do método de instalação), bem como possíveis problemas ou dificuldades que possam surgir.assets(Imagem)includes(Arquivo PHP adicional)js、cssCrie subdiretórios, conforme necessário. Assegure-se de que a estrutura dos arquivos seja clara e organizada.

Se você planeja enviar um plugin para o diretório oficial de plugins do WordPress, é necessário seguir rigorosamente as suas regras e requisitos.Guia para DesenvolvedoresIsso inclui padrões de código, segurança, compatibilidade, bem como o uso do Subversion (SVN) para controle de versões.

Garantir a segurança dos plugins

A segurança é de extrema importância. Sempre verifique, limpe e escape os dados inseridos pelos usuários, bem como os dados dinâmicos.
1. Validação: Verifica se os dados seguem o formato esperado (por exemplo, se são um endereço de e-mail ou um número).
2. Sanitização: Antes de armazenar dados em um banco de dados ou usá-los em outras operações, remova os caracteres inseguros contidos neles. No caso de dados inseridos em formulários, utilize métodos apropriados para realizar essa limpeza.sanitize_text_fieldousanitize_textarea_field。
3. Escapamento (Escaping): Ao exibir dados de um banco de dados em uma página HTML, é necessário garantir que os caracteres especiais sejam convertidos corretamente para evitar ataques XSS. Use métodos apropriados para realizar esse processo.esc_html、esc_attrouwp_kses_post。
Por exemplo, ao exibir os itens de configuração no formulário, utilizamos…esc_attr：

echo '<input ... value="' . esc_attr( $option_value ) . '" ... />';

Planejar o caminho de atualizações futuras

Defina um número de versão claro para o seu plugin (por exemplo, 1.0.0), seguindo o padrão de controle de versão semântico. A cada atualização, atualize a nota no início do arquivo principal do plugin com as informações da nova versão.VersionInformações.
Se a atualização de um plugin exigir a alteração da estrutura do banco de dados ou a migração de dados, você pode utilizar o mecanismo de atualização do WordPress. Você pode comparar…get_option( ‘myplugin_version’ )Quando são detectadas alterações na versão, a tarefa de atualização é executada com base nos números de versão antigos armazenados e no número de versão atual.
Mantenha a compatibilidade dos plugins com as últimas versões do WordPress e do PHP, realize testes regularmente e continue aprimorando-os com base no feedback dos usuários.

resumos

O desenvolvimento de plugins para o WordPress é um processo que transforma ideias em funcionalidades, aprimorando, assim, a capacidade de um site. Começando com a criação de um plugin simples…phpO início do processo envolve a utilização de ganchos de ação (action hooks) e ganchos de filtro (filter hooks) para integrar funcionalidades, a construção de uma interface de configuração amigável ao usuário através da API Settings, e, por fim, a publicação e manutenção do código seguindo normas de segurança e de gerenciamento de versões. Cada etapa reflete o conceito de desenvolvimento modular e padronizado. O essencial é compreender profundamente o sistema de ganchos e a API do WordPress, sempre priorizando a segurança e a experiência do usuário. Com essas bases, você estará em condições de criar ferramentas poderosas que atendam a necessidades específicas, realizando verdadeiramente a criação do “zero a um”.

Perguntas frequentes Perguntas frequentes

Quais são os conhecimentos básicos necessários para desenvolver um plugin do WordPress?

Você precisa ter conhecimentos básicos da linguagem de programação PHP, pois ela é o principal idioma de desenvolvimento do WordPress. Além disso, é essencial ter um entendimento básico de HTML, CSS e JavaScript para lidar com a apresentação e a interação do lado cliente (front-end). É fundamental compreender os conceitos básicos do banco de dados MySQL (como consultas), as funções centrais do WordPress, os ganchos (Actions e Filters), bem como as APIs comuns (como a API Options).

Como depurar o plugin que desenvolvi?

Existem várias métodos eficazes de depuração para o desenvolvimento de plugins para o WordPress. Primeiramente, assegure-se de que…wp-config.phpO ficheiro foi aberto.WP_DEBUGeWP_DEBUG_LOGDessa maneira, os erros e as informações serão registrados./wp-content/debug.logNo arquivo, evite exibir o conteúdo diretamente para o usuário. Em segundo lugar, é possível utilizar essa prática de forma ampla.error_log()A função imprime as informações das variáveis no log. Além disso, usar as ferramentas de desenvolvimento do navegador (tagas Console e Network) para verificar erros em JavaScript do lado cliente e solicitações de API, bem como utilizar IDEs profissionais (como PHPStorm, VS Code) para depurar com pontos de interrupção, são métodos muito eficientes.

Os plugins podem chamar APIs de terceiros?

Claro que sim. Os plugins do WordPress podem acessar APIs de terceiros (como serviços de previsão do tempo, redes sociais, gateways de pagamento, etc.). Ao fazer isso, é necessário utilizar as funções de API HTTP fornecidas pelo WordPress.wp_remote_get()、wp_remote_post()Elas são melhores do que o cURL nativo do PHP ou…file_get_contentsMais seguro e conta com mecanismos internos de timeout e tentativas repetidas. É essencial lidar com possíveis falhas nas chamadas à API (como timeouts de rede ou códigos de erro retornados), além de realizar uma verificação rigorosa e a limpeza dos dados recebidos para garantir sua segurança.

Como meu plugin pode ser internacionalizado para suportar vários idiomas?

O WordPress utiliza a tecnologia GNU gettext para implementar a internacionalização (i18n) e a localização. No seu plugin, todo o texto que precisa ser traduzido deve ser encapsulado usando funções específicas.__('文本', 'my-plugin-textdomain')Usado para retornar a string traduzida._e('文本', 'my-plugin-textdomain')Para uso direto na saída, você precisa definir isso no cabeçalho do arquivo do plugin.Text DomainE use também…load_plugin_textdomain()A função é executada no momento apropriado (por exemplo, quando...).initAção: Carregar o arquivo de tradução. Em seguida, usar uma ferramenta como o Poedit para criar a tradução..potArquivo de modelo, usado pelos tradutores para gerar textos em diferentes idiomas..poe.moDocumentos.

O que deve ser considerado ao desenvolver plugins comerciais?

O desenvolvimento de plugins comerciais exige um maior nível de profissionalismo. A qualidade do código, o design da arquitetura, a segurança e o desempenho devem atender a padrões mais elevados. É necessário criar um sistema de verificação de licenças claro e sem conflitos (geralmente implementado através de um próprio servidor ou de serviços de terceiros). É essencial fornecer documentação técnica profissional, manuais para os usuários e canais de suporte técnico ágeis. A integração de um mecanismo de atualização automática no plugin (utilizando o próprio servidor, em vez do WordPress.org) facilita que os usuários obtenham novas versões e patches. Além disso, é crucial esclarecer o contrato de uso e a política de privacidade, e garantir que o plugin cumpra com regulamentos de proteção de dados, como o GDPR.