Guia de Iniciação para Desenvolvimento de Plugins para WordPress: Do Nível Zero até o Processo Completo de Lançamento

Preparação e configuração do ambiente de desenvolvimento

Antes de começar a escrever qualquer código, um ambiente de desenvolvimento científico é o primeiro passo para o sucesso. Primeiro, você precisa instalar um ambiente WordPress local. É altamente recomendável usar ambientes integrados, como XAMPP, MAMP, Local by Flywheel ou Laragon, que podem configurar o PHP, o MySQL e o servidor web (geralmente Apache ou Nginx) com um único clique. Certifique-se de que a versão do PHP do seu ambiente de desenvolvimento seja compatível com a versão do WordPress pretendida; geralmente, recomenda-se usar o PHP 7.4 ou uma versão superior.

Em seguida, você precisa de um editor de código ou de um ambiente de desenvolvimento integrado (IDE). PHPStorm, Visual Studio Code ou Sublime Text são excelentes opções, pois oferecem recursos como realce de sintaxe, depuração de código e integração de controle de versão. Usar um editor que mostre claramente a estrutura de diretórios é fundamental para entender a organização dos arquivos do plugin do WordPress.

Antes de começar a programar, você precisa entender os arquivos principais dos plugins do WordPress. Cada plugin é composto, no mínimo, por um arquivo PHP principal, por exemplo, chamado my-first-plugin.phpEste ficheiro deve incluir informações especiais no cabeçalho do plug-in, que funciona como um “bilhete de identidade” do plug-in, fornecendo informações básicas sobre o mesmo ao WordPress. Ao mesmo tempo, planeie a estrutura de diretórios do plug-in. Embora os plug-ins simples possam ter apenas um ficheiro, os plug-ins complexos geralmente contêm vários diretórios, como por exemplo: /assets/ Armazenar ficheiros CSS e JavaScript,/includes/ Armazenar ficheiros de tipo funcional,/languages/ Armazenar documentos internacionais. Estabelecer uma estrutura clara ajuda na manutenção e na colaboração em equipa.

Leitura recomendada Aprenda a desenvolver plugins para o WordPress do zero: guia completo e tutoriais práticos.。

O processo de desenvolvimento de plugins principais.

O processo central de criação de um plugin começa com a escrita do ficheiro principal. Todos os plugins devem começar com uma determinada secção de cabeçalho, que é utilizada para fornecer informações ao WordPress sobre o nome do plugin, a descrição, a versão, o autor, etc.

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

A seguir, um exemplo do ficheiro principal do plug-in mais básico, que deve ser colocado diretamente em /wp-content/plugins/ Por exemplo, na pasta "Catálogo", example-plugin/example-plugin.php。

<?php
/**
 * 插件名称: 我的第一个插件
 * 插件 URI: https://example.com/my-first-plugin
 * 描述: 这是一个用于演示的基础WordPress插件。
 * 版本: 1.0.0
 * 作者: 张三
 * 作者 URI: https://example.com
 * 许可证: GPL v2 or later
 * 文本域: my-first-plugin
 */

// 防止直接访问文件
if ( ! defined( 'ABSPATH' ) ) {
    exit; // 如果ABSPATH未定义，则退出脚本
}

Depois de salvar este ficheiro, poderá vê-lo e ativá-lo na página “Plugins” do WordPress. Embora ainda não faça nada, isto indica que a estrutura básica do plugin foi criada. A seguir, necessita de introduzir a lógica das funcionalidades principais.

Uma função típica consiste em alterar o conteúdo de uma página ou artigo do WordPress. Podemos criar uma função simples e, em seguida, instalá-la no conteúdo através dos ganchos de filtro do WordPress. Por exemplo, o código abaixo adiciona automaticamente um texto personalizado no final de cada artigo. Primeiro, definimos uma função de filtro: myplugin_add_footer_textE então, use… add_filter A função o monta (ou o associa) em um determinado local ou sistema. the_content No filtro.

// 在文章内容末尾添加自定义文本的函数
function myplugin_add_footer_text( $content ) {
    // 仅对主循环中的文章单页生效
    if ( is_single() && in_the_loop() && is_main_query() ) {
        $custom_text = '<p><em>Este artigo foi melhorado pelo “Meu Primeiro Plugin”.</em></p>'function myplugin_add_footer_text($content) {  
    if (isset($content)) {  
        $$content = $content;  
        $$custom_text = get_the_custom_text();  
        if (isset($$custom_text)) {  
            $$content .= $$custom_text;  
        }  
    }  
    return $$content;  
}
// Adiciona a função ao filtro 'the_content'  
add_filter( 'the_content', 'myplugin_add_footer_text' );

Além dos filtros, os ganchos de ação (Action Hook) também são fundamentais para estender as funcionalidades do WordPress. Ao contrário dos filtros, as ações são normalmente utilizadas para executar tarefas num momento específico, como, por exemplo, adicionar uma página de menu no painel de administração. Pode utilizar add_action Usar uma função para montar a sua função. Por exemplo, adicionar um item de menu de configuração em segundo plano é normalmente montado em admin_menu Este é um gatilho de ação.

Leitura recomendada Dominando o desenvolvimento de plugins para o WordPress do zero: Construindo funcionalidades personalizadas e melhores práticas。

Funções avançadas e integração

Quando o número de funcionalidades do plug-in aumenta, torna-se difícil gerir todo o código no ficheiro principal. O desenvolvimento avançado de plug-ins incentiva a utilização da programação orientada a objetos (POO) para organizar o código. Ao criar uma classe que representa as funcionalidades principais do plug-in, pode agrupar melhor os dados e as funcionalidades, reduzindo os conflitos de nomenclatura.

Aqui está um exemplo simples de como criar uma função de código curto usando métodos de classe. Vamos criar uma classe. My_Shortcode_Plugin Para registar um código curto. Primeiro, tem de definir o método de construção da classe e registar o código curto nela.

class My_Shortcode_Plugin {
    public function __construct() {
        // 在构造函数中注册短代码
        add_shortcode( 'greeting', array( $this, 'render_greeting_shortcode' ) );
    }

// 短代码渲染函数
    public function render_greeting_shortcode( $atts, $content = null ) {
        // 处理短代码属性
        $atts = shortcode_atts( array(
            'name' => '访客',
        ), $atts, 'greeting' );

// 返回渲染的输出
        return '<div class="greeting">Olá, ' . esc_html( $atts['name'] ) . '!'. $content . '</div>';
    }
}
// 实例化插件类
new My_Shortcode_Plugin();

Além da funcionalidade em si, um bom plugin deve considerar o estilo e a interação do front-end. Isso significa que você precisa integrar arquivos CSS e JavaScript de forma segura. O WordPress oferece uma API completa para registrar e incluir scripts e folhas de estilo.

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

Você pode fazer isso através de… wp_register_script、wp_register_style E a função de adesão correspondente. wp_enqueue_script e wp_enqueue_style Por exemplo, o código abaixo demonstra como registrar e adicionar a folha de estilos do plug-in no front-end. Normalmente, nós iríamos wp_enqueue_scripts Os ganchos são utilizados na parte frontal, enquanto que... admin_enqueue_scripts Os ganchos são utilizados em segundo plano.

// 注册并加入插件前端样式和脚本的函数
function myplugin_enqueue_assets() {
    // 注册一个CSS文件
    wp_register_style(
        'myplugin-frontend-style',
        plugins_url( 'assets/css/frontend.css', __FILE__ ),
        array(),
        '1.0.0'
    );
    // 将CSS文件加入队列
    wp_enqueue_style( 'myplugin-frontend-style' );
}
// 挂载到 `wp_enqueue_scripts` 钩子（前端）
add_action( 'wp_enqueue_scripts', 'myplugin_enqueue_assets' );

Além disso, criar uma página de opções de back-end é uma necessidade comum dos plugins modernos. Isso requer o uso da API de Configurações do WordPress, que fornece uma maneira segura e padronizada de criar, validar e salvar opções de configuração. Você precisa usar add_options_page A função para adicionar páginas de submenu e usar register_setting、add_settings_section e add_settings_field Funções como essas são usadas para construir formulários de configuração e processar dados.

Teste, empacotamento e publicação de plugins.

Depois de concluir a codificação, testes rigorosos são fundamentais para garantir a qualidade do plug-in. Você precisa testá-lo em diferentes ambientes. Certifique-se de testar as funcionalidades principais no seu ambiente de desenvolvimento local e, em seguida, testar a compatibilidade no servidor de testes que simula o ambiente online. Os testes devem incluir: compatibilidade com as versões atual e anterior do WordPress; compatibilidade com os temas que você usa e outros plug-ins populares; compatibilidade com versões antigas e novas do PHP (por exemplo, PHP 7.4 e 8.x); e testes de desempenho do front-end em diferentes navegadores (por exemplo, Chrome, Firefox, Safari). Ativar o modo de depuração do WordPress pode ajudá-lo a detectar erros ou avisos do PHP. wp-config.php Configurações no arquivo WP_DEBUG Para true É possível ativar esta funcionalidade.

Leitura recomendada Guia de Início para Desenvolvimento de Plugins para WordPress: Construa sua Primeira Extensão de Funcionalidade do Zero。

Após confirmar que o plugin está estável, você precisa fazer os preparativos antes da embalagem. Isso inclui pelo menos dois passos fundamentais: a internacionalização do código (i18n) e a preparação do arquivo Readme. A internacionalização permite que o seu plugin suporte vários idiomas, o que é fundamental para que o plugin alcance um público global. Você precisa usar as funções de tradução do WordPress para todas as strings exibidas aos usuários, por exemplo: ()、_e() e esc_html()Ao mesmo tempo, no /languages/ Coloque um ficheiro de modelo POT na pasta para que os tradutores possam utilizá-lo.

Outro documento necessário é um formulário padrão. readme.txtIsso é usado para a exibição no diretório oficial de plugins do WordPress e deve ser escrito em um formato de sintaxe específico, incluindo o nome do plugin, a descrição, os passos de instalação, as perguntas frequentes, o registro de atualizações e outros conteúdos. O WordPress.org exige que readme.txt O formato tem requisitos rigorosos, e pode consultar a documentação oficial para o escrever.

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

Após a conclusão dos preparativos, pode começar a empacotar. Crie uma pasta temporária e copie para ela todos os ficheiros do plug-in, exceto as ferramentas de desenvolvimento (como o diretório Git e os ficheiros de configuração do IDE) e os ficheiros finais desnecessários (como os ficheiros PSD originais). Certifique-se de que os caminhos e as permissões de todos os ficheiros estão corretos. Em seguida, compacte-os num ficheiro ZIP utilizando uma ferramenta de compressão ZIP, por exemplo. my-first-plugin-v1.0.0.zipO diretório raiz deste ficheiro ZIP deve conter diretamente a pasta do seu plug-in.

Por fim, chega a emocionante fase de publicação. Pode solicitar um repositório de código SVN gratuito no WordPress.org, que é a única forma de publicar o plug-in no diretório oficial. Terá de dominar os comandos básicos do SVN para submeter o código do plug-in, devidamente organizado, ao repositório pela primeira vez. /trunk/ Índice. Os documentos processados serão readme.txt Depois de atualizar o número de versão estável no ficheiro principal, pode criar uma nova etiqueta SVN (por exemplo, /tags/1.0.0/Para publicar uma versão, você deve usar o WordPress.org. Após o envio, o sistema do WordPress.org processará automaticamente o pedido e, geralmente, o seu plugin estará disponível no diretório oficial algumas horas depois, para que usuários de todo o mundo possam pesquisar e instalá-lo.

resumos

Desenvolver um plugin WordPress do zero é uma jornada sistemática e gratificante. Começa com a configuração de um ambiente local e a compreensão da estrutura dos arquivos principais, passando pela escrita de metadados do plugin e a utilização de filtros e ganchos de ação para implementar as funcionalidades principais. À medida que as necessidades se tornam mais complexas, torna-se essencial adotar a programação orientada a objetos, incorporar recursos front-end de forma segura e criar uma interface de administração back-end. No final do ciclo de desenvolvimento, testes de compatibilidade abrangentes, preparação rigorosa de internacionalização e documentação, além de seguir processos padrão de empacotamento e publicação, garantem que o plugin passe de um trabalho pessoal para um produto confiável disponível para a comunidade. Dominar todo este processo não só lhe permite resolver necessidades específicas do site, mas também participar ativamente na construção da ecologia do WordPress.

Perguntas frequentes Perguntas frequentes

Quais conhecimentos prévios são necessários para desenvolver plugins?
Para desenvolver um plugin do WordPress, primeiro é necessário ter uma base sólida em programação PHP, uma vez que o código do plugin é escrito principalmente em PHP. Ao mesmo tempo, é necessário ter um conhecimento básico de HTML, CSS e JavaScript para lidar com a apresentação e a interação do front-end. Ter conhecimento dos conceitos básicos do WordPress, como temas, ganchos (Hooks), códigos curtos (Shortcode), consultas (Query) e várias APIs (como a API de Opções, a API REST), é fundamental para um desenvolvimento eficiente. Embora não seja necessário ser um especialista em todos os aspectos, ter esse conhecimento pode ajudar a evitar problemas durante o desenvolvimento.

Como depurar eficazmente erros em plugins personalizados?

O método de depuração mais eficaz é ativar o modo de depuração do WordPress. No site do wp-config.php No arquivo, encontre e defina o valor desejado. define( 'WP_DEBUG', true );Isso irá mostrar diretamente na página os erros, avisos e notificações do PHP.

Para ver os conteúdos das variáveis e matrizes com mais clareza, pode-se usar uma combinação de error_log() A função registra as informações no registo de erros do servidor ou utiliza funções auxiliares, como por exemplo, print_r() ou var_dump()E exporte-o como HTML. <pre> Etiquete os pacotes para uma apresentação formatada. Além disso, é essencial utilizar as ferramentas de desenvolvedor do navegador (F12) para verificar as solicitações de rede e os erros do console JavaScript. Para lógicas complexas, considere utilizar ferramentas de depuração profissionais, como o Xdebug.

Por que o meu plugin não produziu nenhuma alteração no site após a sua ativação em segundo plano?

Isso geralmente é causado por vários motivos comuns. Primeiro, verifique se o seu código de função está sendo executado corretamente. Certifique-se de que a sua função já passou por add_action ou add_filter Está montado nos ganchos corretos e esses ganchos são acionados nas páginas que você deseja (como front-end, back-end).

Em segundo lugar, confirme que o seu plugin não foi desativado silenciosamente devido a erros de sintaxe ou erros fatais. Verifique a página “Plugins Instalados” no painel de administração do WordPress. Se o nome do seu plugin tiver mudado para “Plugins Danificados”, isso geralmente significa que as informações do cabeçalho do plugin estão incompletas ou que o ficheiro principal contém erros de sintaxe. Por último, verifique se a sua lógica de código inclui testes condicionais (como <). is_single(), is_admin()Essas condições podem não ser atendidas na página atual, o que pode levar à não execução da função.

Como adicionar opções de configuração para os utilizadores no plugin?

Recomenda-se utilizar a API de configurações nativa do WordPress para criar itens de configuração, pois é o método mais seguro e padrão. O processo básico é o seguinte: primeiro, utilize add_menu_page() ou add_options_page() A função adiciona uma página de menu em segundo plano. Em seguida, use register_setting() A função regista um grupo de definições (utilizado para verificação de segurança e armazenamento). Em seguida, utiliza-se add_settings_section() Adicione grupos regionais à sua página de configurações. Por fim, use add_settings_field() Adicione campos de formulário específicos (como caixas de texto e menus pendentes) ao grupo. Você precisa escrever uma função de callback para renderizar o HTML de cada campo e, por fim, usá-lo na função de callback da página do menu. settings_fields() e do_settings_sections() Para exibir todo o formulário. Após o utilizador o submeter, o WordPress irá processar automaticamente a guarda e a validação dos dados.

Como submeter um plugin para o diretório oficial de plugins do WordPress?

Para submeter o plugin ao diretório oficial, você precisa primeiro registar uma conta no WordPress.org. Em seguida, aceda à página de submissão de plugins para solicitar um novo repositório SVN para o plugin. Após a aprovação da solicitação, você receberá o endereço do repositório SVN. Em seguida, você precisa preparar os ficheiros do plugin de acordo com as normas oficiais, especialmente no que diz respeito aos requisitos. readme.txt Arquivos e ficheiros PHP principais que contêm anotações de cabeçalho padrão.

Use o cliente SVN (como uma ferramenta de linha de comando ou TortoiseSVN) para enviar o código do seu plug-in para o repositório pela primeira vez. /trunk/ Índice. Quando uma versão estável for lançada, será /trunk/ O conteúdo foi copiado para /tags/ Crie uma nova tag no diretório (por exemplo, “new_tag”). /tags/1.0.0/e irá readme.txt O campo “Stable tag” no WordPress é atualizado para este número de versão. Após o envio, o WordPress.org irá analisar e processar automaticamente e, após algum tempo, o seu plugin irá aparecer no diretório oficial.