Para desenvolver um plugin para o WordPress, é necessário primeiro acessar o diretório de instalação do WordPress. wp-content/plugins Crie uma pasta exclusiva dentro da pasta principal. O nome dessa pasta deve estar relacionado à função principal ou ao nome do seu plugin, e é recomendável usar apenas letras minúsculas e hifens, por exemplo: my-first-plugin。
Em seguida, você precisa criar o arquivo principal do plugin dentro desta pasta. Este arquivo geralmente recebe o nome do próprio plugin, por exemplo… my-first-plugin.phpEste arquivo é a entrada para o plugin, e sua parte superior deve conter um comentário de cabeçalho do plugin que atenda aos padrões do WordPress. Este bloco de comentários é usado para fornecer informações básicas sobre o plugin ao sistema WordPress e é essencial para que o plugin seja reconhecido e ativado.
Uma típica anotação de cabeça de um plugin é a seguinte:
Leitura recomendada Dominando o Desenvolvimento de Plugins para WordPress do Zero: Um Guia Completo com Exercícios Práticos。
<?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 criar e preencher esse arquivo, você poderá ver o seu plugin na página de “Plugins” no painel de administração do WordPress e ativá-lo. Isso marca o início oficial da sua jornada no desenvolvimento de plugins.
Compreender a estrutura básica de um plugin
Um plugin para o WordPress bem estruturado não só é fácil de ser mantido pelo próprio desenvolvedor, como também é mais compreensível para outros desenvolvedores. Seguir métodos de organização padrão torna o seu código mais claro e profissional.
Modo de organização dos arquivos e diretórios principais
Além do arquivo principal do plugin, um plugin com funcionalidades completas geralmente contém vários diretórios e arquivos. Por exemplo,includes/ O diretório é usado para armazenar os arquivos das classes ou funções PHP principais.admin/ O diretório contém o código relacionado à interface de gerenciamento do backend.public/ ou frontend/ O diretório contém o código destinado aos visitantes do site.assets/ O diretório é usado para armazenar recursos estáticos, como JavaScript, CSS e imagens.
Além disso, pode ser necessário também… languages/ O diretório contém os arquivos de tradução internacionalizados (.po/.mo), além de outro arquivo. uninstall.php O arquivo é usado para gerenciar o processo de limpeza quando um plugin é removido. Uma estrutura de diretórios adequada é a base para a criação de plugins mantíveis e expansíveis.
ciclo de vida de plugins e ganchos padrão
Os plugins do WordPress interagem com o sistema principal através de uma série de “ganchos” (Hooks). Para entender o ciclo de vida de um plugin, é essencial compreender a ordem de execução desses ganchos. Quando o WordPress processa uma solicitação, ele carrega sequencialmente os arquivos principais do sistema, o tema atual e os plugins ativados.
Leitura recomendada Guia Completo para o Desenvolvimento de Plugins para WordPress: Do Início à Prática Avançada。
Os desenvolvedores de plugins podem aproveitar isso. register_activation_hook Execute tarefas únicas uma única vez quando o plugin for ativado, como, por exemplo, criar tabelas em um banco de dados. Da mesma forma…register_deactivation_hook É utilizado para gerenciar as ações a serem executadas quando um plugin é desativado (note que isso não significa que o plugin será excluído). register_uninstall_hook Ou um independente. uninstall.php Os arquivos são utilizados para limpar os dados quando o plugin for removido do WordPress.
No funcionamento diário, os dois tipos de ganchos (hooks) mais utilizados são as Ações (Actions) e os Filtros (Filters). As Ações permitem que você execute alguma ação em um momento específico (por exemplo, quando um evento específico ocorrer). initInsira o código para executar a função; os filtros, por sua vez, permitem que você modifique os dados passados para outras funções. the_content）。
Implementar as funcionalidades principais e a interação com as medidas de segurança.
O principal objetivo do desenvolvimento de plugins é adicionar novas funcionalidades ao WordPress. Seja para adicionar um atalho, criar uma pequena ferramenta ou processar dados de formulários, é necessário seguir as normas de segurança e interação do WordPress.
Crie um código curto para exibir o conteúdo.
Códigos curtos (Shortcodes) são ferramentas poderosas que permitem que os usuários insiram conteúdo dinâmico em artigos ou páginas através de um simples marcador. Você pode usá-los para... add_shortcode Você pode criar uma função para registrar seu próprio código curto.
Por exemplo, o código a seguir registra um elemento com o nome… greet É um código abreviado que aceita um parâmetro. name Atributos e cumprimentos ao usuário:
function myplugin_greet_shortcode( $atts ) {
// 使用 shortcode_atts 函数设置默认值并合并用户属性，确保安全性
$atts = shortcode_atts( array(
'name' => '访客',
), $atts, 'greet' );
// 在输出前对用户输入进行转义
$name = esc_html( $atts['name'] );
return '<p>Olá, '.$name'.‘! Bem-vindo(a) a este site.</p>'php
add_shortcode('greet', 'myplugin_greet_shortcode');Os usuários podem inserir conteúdo no editor de artigos. [greet name=“小明”]No lado front-end, será exibido: “Olá, Xiao Ming! Bem-vindo ao nosso site.” Lembre-se de que todos os dados coletados dos usuários devem ser devidamente escapados ou verificados antes de serem exibidos, assim como foi feito no exemplo acima. esc_html。
Leitura recomendada Guia de Início para Desenvolvimento de Plugins para WordPress: Crie o Seu Primeiro Plugin Personalizado do Zero。
Adicionar página de configurações ao plugin
Para plugins que requerem configurações por parte do usuário, criar uma página de opções no backend é uma prática padrão. Você pode utilizar a “API de Configurações” do WordPress para adicionar páginas e campos de forma segura e conveniente; essa API lida automaticamente com a verificação de segurança (nonce) e o armazenamento de dados.
Primeiro, use add_options_page ou add_menu_page Adicione um item de menu e uma página para essas funções no painel de controle (backend). Em seguida, utilize-as conforme necessário. register_setting、add_settings_section e add_settings_field Use funções como essas para definir as suas opções de configuração.
A seguir, está um código de estrutura para criar uma página de configurações simples:
function myplugin_add_admin_menu() {
add_options_page(
'我的插件设置', // 页面标题
'我的插件', // 菜单标题
'manage_options', // 所需权限
'myplugin-settings', // 菜单 Slug
'myplugin_settings_page' // 用于渲染页面的回调函数
);
}
add_action( 'admin_menu', 'myplugin_add_admin_menu' );
function myplugin_settings_init() {
register_setting( 'myplugin_settings_page', 'myplugin_settings' );
add_settings_section( 'myplugin_section', '基础设置', null, 'myplugin_settings_page' );
add_settings_field(
'api_key',
'API 密钥',
'myplugin_api_key_field_render', // 渲染输入字段的函数
'myplugin_settings_page',
'myplugin_section'
);
}
add_action( 'admin_init', 'myplugin_settings_init' );
function myplugin_api_key_field_render() {
$options = get_option( 'myplugin_settings' );
$value = isset( $options['api_key'] ) ? esc_attr( $options['api_key'] ) : '';
echo '<input type="text" name="myplugin_settings[api_key]" value="' . $value . '" />';
}
function myplugin_settings_page() {
?>
<form action='/pt/options.php/' method='post' data-trp-original-action="options.php">
<h2>Configurações do meu plugin</h2>
<?php
settings_fields( 'myplugin_settings_page' );
do_settings_sections( 'myplugin_settings_page' );
submit_button();
?>
<input type="hidden" name="trp-form-language" value="pt"/></form>
<?php
}O uso da API de configurações garante que as opções do seu plugin sejam salvadas de forma segura. wp_options O conteúdo está armazenado em uma tabela, e a interface de gerenciamento segue o estilo padrão do WordPress.
Seguir as melhores práticas de desenvolvimento
Para criar um plugin que funcione de forma estável a longo prazo, seja fácil de manter e que se integre bem com outros plugins, é necessário seguir algumas boas práticas essenciais.
Assegurar a segurança do código
A segurança é de extrema importância no desenvolvimento de plugins. É necessário verificar, limpar e escapalar todos os dados inseridos pelos usuários (incluindo aqueles provenientes de URLs, formulários, cookies e bancos de dados). Para isso, utilize as funções disponíveis no WordPress. esc_html、esc_url、sanitize_text_field Vamos lidar com a saída; use isso. wp_verify_nonce e check_admin_referer Isso é feito para verificar a legitimidade da solicitação e evitar ataques de falsificação de solicitações entre sites (CSRF – Cross-Site Request Forgery).
Ao realizar consultas no banco de dados, é essencial utilizar… $wpdb Os métodos fornecidos pela classe (como…) prepareIsso é feito para evitar ataques de injeção de SQL. Nunca deve-se concatenar diretamente os dados fornecidos pelo usuário às instruções SQL.
Implementar internacionalização e localização
Para que o seu plugin possa ser usado por usuários do WordPress em todo o mundo, a internacionalização (i18n) é essencial. Isso significa que você precisa utilizar as funções de tradução do WordPress para encapsular todas as strings direcionadas aos usuários.
Defina isso nos comentários no início do seu plugin. Text Domain(Por exemplo, my-first-plugine Domain PathNo código, use para todas as strings que precisam ser traduzidas. __() Para fazer a tradução, use _e() Fazer a tradução e exportá-la diretamente, usando _n() Lidar com as formas singular e plural.
Exemplo:$text = __(‘Hello World’， ‘my-first-plugin’);Depois, você pode usar ferramentas como o Poedit para gerar o conteúdo desejado. .pot Arquivo de modelo, para que os tradutores possam criá-lo. .po e .mo Arquivo. Coloque o arquivo de tradução no diretório raiz do plugin. /languages Ao criar uma pasta, o WordPress carregará automaticamente as traduções correspondentes de acordo com o idioma do site.
Optimizar o código e considerar o desempenho
Plugins com desempenho ruim podem atrasar todo o site. Deve-se evitar a execução de um grande volume de código desnecessário a cada carregamento de página. Scripts e estilos que são usados apenas no backend devem ser carregados apenas com base em condições específicas (por exemplo, através de verificações lógicas). is_admin()Carregado apenas em segundo plano; os recursos da interface do usuário são enviados através de… wp_enqueue_script() e wp_enqueue_style() Nos ganchos apropriados (como…) wp_enqueue_scriptsÉ carregado em fila de espera dentro desse processo.
Para operações demoradas ou chamadas a APIs externas, considere usar o Transients API do WordPress.set_transient， get_transient) Realize o cacheamento. Além disso, assegure-se de que, ao desativar ou excluir o plugin, ele seja removido de forma adequada. uninstall.php Limpe as tabelas e opções do banco de dados que você criou, mas faça isso com cuidado, oferecendo aos usuários a opção de decidir se desejam que os dados sejam excluídos ou não.
Depuração, teste e lançamento
Antes de entregar seu plugin aos usuários, um cuidadoso processo de depuração, teste e preparação é um passo essencial para garantir o sucesso.
Utilizando as ferramentas de depuração do WordPress
Durante a fase de desenvolvimento, é altamente recomendado ativar o modo de depuração do WordPress. wp-config.php Configurações no arquivo define(‘WP_DEBUG’， true);Isso fará com que todos os erros, avisos e notificações do PHP sejam exibidos, ajudando você a localizar o problema rapidamente. Você também pode ativar isso simultaneamente. WP_DEBUG_LOG Registre os erros em um arquivo de log, ou ative essa funcionalidade. SCRIPT_DEBUG Isso permite carregar arquivos JavaScript e CSS não compactados, facilitando o processo de depuração.
Preparando as informações para o lançamento do plugin.
Se você planeja enviar um plugin para o diretório oficial de plugins do WordPress.org, você precisará preparar uma série de materiais. Isso inclui um documento detalhado… readme.txt O arquivo deve ter um formato que atenda aos requisitos do WordPress e conter informações como descrição do plugin, instruções de instalação, dúvidas comuns, registros de atualizações, etc. Você também precisará fornecer imagens de banners e ícones de alta qualidade, além de preencher a descrição do repositório SVN do plugin.
No nível do código, certifique-se de que você já concluiu os preparativos para a internacionalização e verifique cuidadosamente se todo o código está em conformidade com os padrões de codificação do WordPress. Você pode usar o PHP_CodeSniffer localmente, juntamente com as regras de codificação do WordPress, para realizar essa verificação.
Realizar testes de compatibilidade entre diferentes ambientes.
Antes de publicar, é necessário testar seu plugin em vários ambientes. Isso inclui diferentes versões do WordPress (especialmente a versão atual e a versão anterior principal), diferentes versões do PHP (como PHP 7.4, 8.0, 8.1), diferentes versões de bancos de dados (MySQL/MariaDB), além de testes de compatibilidade com temas populares e outros plugins. Certifique-se de que seu plugin não apresente erros ou avisos em nenhuma das fases de ativação, desativação, configuração ou uso.
resumos
O desenvolvimento de plugins para o WordPress é um processo que transforma ideias em funcionalidades e as integra em uma vasta ecossistema. Comece criando um arquivo principal que atenda aos padrões estabelecidos, construa gradualmente uma estrutura de diretórios organizada e compreenda profundamente os mecanismos de interação centrais, como as ações (actions) e os ganchos de filtros (filters). Ao implementar funcionalidades específicas, como códigos curtos e páginas de configuração, é essencial adotar práticas de segurança (verificação, escape de dados, proteção contra injeções de código) e internacionalização no seu código. Siga as melhores práticas, como otimizar o desempenho, gerenciar recursos de forma eficiente e utilizar ferramentas de depuração para garantir a qualidade do código. Por fim, após testes abrangentes em diferentes ambientes e uma preparação completa para o lançamento, seu plugin estará pronto para servir usuários do WordPress em todo o mundo de forma estável e segura. A aprendizagem contínua dos manuais oficiais e dos recursos da comunidade é a chave para a melhoria constante na sua habilidade de desenvolvimento de plugins.
Perguntas frequentes Perguntas frequentes
Quais são as noções básicas necessárias para desenvolver plugins para o WordPress?
Você precisa ter uma base sólida em programação PHP, pois a lógica central do plugin é escrita em PHP. Além disso, é necessário ter um conhecimento básico de HTML, CSS e JavaScript para construir a interface e as interações com o usuário. O mais importante é que você esteja familiarizado com a arquitetura básica do WordPress, incluindo seu sistema de ganchos (actions e filters), o ciclo de temas, a estrutura do banco de dados, bem como o uso de várias funções e classes centrais do sistema.
Como posso evitar conflitos entre meu plug-in e outros plug-ins?
Adicionar um prefixo único a todas as suas funções, classes, constantes, etiquetas de ações/filtros e nomes de opções é a maneira mais eficaz de evitar conflitos. Não use nomes genéricos. add_user() ou $countPelo contrário, deve-se usar um prefixo relacionado ao seu plugin, por exemplo… myplugin_add_user() ou $myplugin_countEncapsular seu código em uma classe ou namespace também é uma boa prática. Além disso, ao organizar scripts de fila de espera e estilos, use identificadores únicos (handles) e considere carregar recursos conforme necessário.
Onde devo armazenar os dados do plugin?
Para opções de configuração simples, use a API de Opções do WordPress (Options API).add_option, get_option, update_optionArmazene os dados em… wp_options A tabela é a forma mais simples e padrão para armazenar dados. Se você precisar armazenar uma grande quantidade de dados personalizados e estruturados (por exemplo, produtos, pedidos, etc.), deve criar tabelas de banco de dados personalizadas. $wpdb Objeto e, ao ativar o plugin, é processado através… dbDelta() Funções para criar e atualizar a estrutura de tabelas, o que garante a compatibilidade entre diferentes versões de bancos de dados.
Depois que um plugin é removido, como limpar os dados que ele criou?
O WordPress oferece duas principais maneiras de fazer isso. A primeira delas é usar… register_uninstall_hook() A função registra um “gancho” de desinstalação. A segunda maneira, e a mais recomendada, é criar um arquivo separado no diretório raiz do plugin. uninstall.php Arquivo. Neste arquivo, você precisa verificar se há alguma chamada interna do WordPress. WP_UNINSTALL_PLUGIN Constante, e então execute a opção de remoção de definições personalizadas (use). delete_optionOperações de limpeza, como a remoção de arquivos desnecessários e tabelas de banco de dados personalizadas. Por favor, lembre-se de informar os usuários no descritivo do plugin sobre quais dados serão excluídos durante o processo de remoção.
O que vem a seguir, o que vem a seguir?
Leitura ampliada e conhecimento prático
Os seguintes estão relacionados ao tópico deste artigo e são adequados para uma leitura mais aprofundada. Geralmente, é melhor priorizar o artigo que está mais próximo do seu problema atual e, em seguida, expandir gradualmente para os tópicos adjacentes.
- Guia de Desenvolvimento de Plugins para WordPress: Crie o seu primeiro plugin personalizado do zero
- Tornar-se um desenvolvedor de plugins para WordPress: Um guia completo do zero ao um
- Guia Completo para Desenvolvimento de Plugins para WordPress: Do Início à Expertise – Criando Extensões Profissionais
- Desenvolvimento de plugins para WordPress: Do básico ao avançado: Construa o seu primeiro plugin personalizado
- Do Zero ao Um: Um Guia Completo para Desenvolver seu Primeiro Plugin para WordPress Passo a Passo
Português do Brasil