Guia do iniciante ao desenvolvimento de plugins WordPress

O WordPress CMS mudou a cara da nossa Internet e permitiu que uma onda de novas ideias prosperasse e o seu movimento de código aberto detém uma forte presença enraizada no desenvolvimento de software e web. WordPress é uma plataforma de blog que tem a capacidade de lançar em muitos outros scripts, como fóruns da web, placas de trabalho e até mesmo um sistema de gerenciamento de conteúdo de página da Web clássico.

Veremos algumas maneiras de começar o desenvolvimento de plug-ins para o WordPress. As etapas são bastante simples e não exigem uma grande dedicação para estudar. O conhecimento rudimentar de PHP seria útil mesmo com um entendimento básico da estrutura de arquivos do WordPress e do painel Administração.

Neste breve tutorial, veremos as etapas básicas necessárias para criar um plug-in simples do WordPress. A funcionalidade será usada para criar trechos dinâmicos com base no número passado em nossa chamada de função. Você precisará fazer o upload do arquivo de plug-in e ativá-lo no painel do administrador e, em seguida, fazer o acompanhamento ligando para nossa função em qualquer página que desejar que o trecho apareça. Links para o código-fonte do plug-in concluído já foram adicionados posteriormente neste artigo :)

Por que desenvolver para WordPress?

Os plug-ins são uma ótima maneira de aprimorar a funcionalidade do seu blog adicionando recursos extras. Estes podem ser colocados em qualquer lugar dentro do seu modelo por ganchos de função. Com o passar do tempo, a extensibilidade do sistema plug-in do WordPress permitiu um enorme crescimento e centenas de softwares enviados por desenvolvedores.

O WordPress oferece especificamente recursos avançados em seu CMS, sendo que os plug-ins exclusivos são poucos e distantes entre si. Como desenvolvedor, você tem controle total sobre as especificidades de back-end do seu blog. Contratar um desenvolvedor PHP para criar um plug-in do sistema custaria muito mais do que você imagina e a API é bastante fácil de se trabalhar e aprender.

Como um argumento secundário, o desenvolvimento do WordPress é uma ótima prática para se ajustar em outras áreas. Construir plugins menores e widgets de barra lateral no WordPress irá ajudá-lo a desenvolver uma compreensão de como o sistema de backend realmente funciona. Isso não se limita apenas ao WordPress, pois você obterá uma compreensão mais profunda da grande maioria dos Sistemas de Conteúdo..

1. Estrutura da Pasta WP

Uma introdução à estrutura de pastas do WordPress mostrará os diretórios básicos do aplicativo. Dentro do wp-content você encontrará um plugins diretório. Aqui é onde todos os seus plug-ins individuais serão hospedados, arquivos únicos ou subdiretórios corretamente nomeados.

Para plug-ins menores que requerem apenas um único arquivo .php, você tem a opção de colocá-lo diretamente no diretório plug-ins /. No entanto, quando você começa a desenvolver aplicativos mais complicados, é muito mais útil criar um subdiretório com o nome do seu plug-in. Dentro de você pode abrigar JavaScript, CSS e HTML inclui junto com suas funções PHP.

UMA readme.txt O arquivo também pode ser útil se você estiver planejando oferecer seu plug-in para download. Este arquivo deve incluir seu nome e o que o plugin faz. Como autor, você também pode considerar incluir detalhes sobre cada revisão e quais atualizações foram lançadas..

2. Iniciando seu arquivo PHP

Ao criar um novo plugin, você precisará começar com um arquivo PHP simples. Isso pode ser chamado de qualquer coisa, mas geralmente deve refletir o nome oficial do seu plug-in. Então, por exemplo, eu criei nosso código base e nomeei meu arquivo hongkiat-excerpt.phps.

As primeiras linhas do seu plug-in devo ser informações de comentário para o mecanismo de análise. Isso é extremamente importante, pois o WordPress não poderá processar seu arquivo sem. Abaixo está um trecho de código de exemplo que você pode copiar e moldar para o seu próprio.

O nome do plug-in é o que aparecerá no seu painel de back-end do administrador quando você for ativar. O mesmo acontece com o URI, que será colocado no painel de detalhes dentro do painel de plug-ins. Embora não seja necessário incluir uma versão ou descrição, isso faz com que seu plug-in pareça muito mais profissional.

3. Convenções de nomenclatura do WordPress e Melhores Práticas

Existem algumas maneiras de realmente estruturar seu plug-in. Muitas vezes os desenvolvedores PHP criam um sistema de classes inteiro para evitar colisões com funções e nomes de variáveis. Se você não estiver familiarizado com a funcionalidade avançada de OOP do PHP, então é melhor escrever seu código em funções de amostra..

Portanto, para nosso código de exemplo, escreveremos uma única função para armazenar nossos dados. Também precisamos definir algumas variáveis ​​que são fundamentais para implementar dentro de nossos arquivos de modelo. Abaixo está um exemplo de código retirado do nosso arquivo de plug-in com a lógica principal removida.

Ao escrever seu código de exemplo, é melhor seguir os regulamentos e guias configurados pelo WordPress. Como existem tantas funções internas já definidas, você pode evitar duplicatas prefixando um rótulo em todas as suas variáveis ​​e nomes de funções..

Nos exemplos acima, prefixamos todos os nomes de nossas configurações com hongkiat. Isso pode ser substituído por qualquer palavra-chave de sua escolha, geralmente relacionada ao nome do seu plugin. O código acima é apenas configurações de amostra e não deve pertencer ao nosso plug-in final. Isso é apenas para dar uma ideia de como os nomes das variáveis ​​e as chamadas de função devem ser escritas.

4. Mergulhar em filtros e ações

Há outro conceito digno de nota antes de entrarmos em nosso código bruto. Ações e filtros são dois conceitos completamente diferentes que se relacionam profundamente nas maneiras como eles manipulam os dados do plugin.

Esses dois bits de código são padrão na API do WordPress. Filtros e ações permitem que os desenvolvedores de plug-ins atualizem os bits de código em todo o painel de administração do WordPress referente ao seu novo plug-in. Isso significa que você pode adicionar uma nova guia na barra lateral ou links de configurações adicionais para suas opções de plug-in.

Entendendo add_filter ()

UMA filtro é usado em um bit de texto ou dados sendo passados ​​para o WordPress. Com filtros você é literalmente capaz de filtrar conteúdo através de suas próprias funções escritas personalizadas para alterar dados de qualquer forma.

Por exemplo, você pode criar um filtro para alterar $ the_content que é uma variável definida pelo WordPress contendo todo o conteúdo da postagem de um artigo do WordPress. Para o nosso plug-in, vamos tomar $ the_content e encurtando o comprimento dos caracteres em um trecho.

Os filtros são úteis quando você está escrevendo plug-ins para personalizar a aparência do seu blog. Eles são especialmente populares ao escrever widgets da barra lateral ou funções menores para alterar a forma como uma postagem deve ser exibida. Abaixo está uma linha de exemplo de código mostrando como aplicar um filtro.

add_filter ('wp_title', 'hongkiat_func');

Aqui estamos adicionando um filtro no título da página do WordPress. Note que este código não está relacionado ao nosso plugin oficial e está sendo usado apenas como exemplo aqui.

o add_filter A função é nativa do WordPress e usada para adicionar um novo filtro a uma variável encontrada no conteúdo da página. Na linha acima, estamos segmentando $ wp_title que contém o título da nossa página atual. Nós estamos passando essa variável para uma função falsa chamada hongkiat_func () que poderia então manipular e retornar uma nova tag de título para quaisquer finalidades.

Entendendo add_action ()

As ações são semelhantes aos filtros, pois não funcionam em bits de dados, mas, em vez disso, segmentam áreas predefinidas em seus modelos e no painel de administração. Como exemplo, você pode aplicar uma ação sempre que atualizar ou editar o conteúdo de uma página. O WordPress oferece uma lista abrangente de ações em sua documentação da API. Abaixo está uma pequena lista de ações de exemplo para você se familiarizar com algumas das áreas de destino predefinidas.

• publish_post - chamado quando uma publicação é publicada ou quando o status é alterado “Publicados”
• save_post - chamado quando um post / página é criado a partir do início ou atualizado
• wp_head - chamado quando o modelo é carregado e executa o wp_head () função
• loop_end - chamado imediatamente após o post final ter sido processado através do loop do WordPress
• trackback_post - chamado sempre que um novo trackback é adicionado em uma postagem

Mais uma vez podemos ver quão simples esse código se resume a. Se você conseguir entender a diferença entre ações e filtros, estará muito mais perto de construir plugins WordPress completos e funcionais. Abaixo está outra linha de código inicializando uma função de ação no save_post gancho. Para esclarecer novamente, isso não diz respeito ao nosso atual plugin de desenvolvimento e é usado apenas como um exemplo de código para entender add_action () função.

add_action ('save_post', 'notify');

Então, aqui nós vemos uma configuração semelhante a antes com add_filter (). Precisamos de duas variáveis, a primeira contém o nome do nosso gancho que estamos mirando. Nesse caso save_post o que significa que sempre que um novo post é salvo, vamos chamar nossa função definida na segunda posição (notify ()). Você poderia, obviamente, atualizar notificar para ser qualquer nome de função que você deseja executar, no entanto, isso não é necessário para o nosso exemplo atual de plug-in.

Terminando nossa lógica de plugins

Terminando em nosso caminho, vamos adicionar nossa função final diretamente ao nosso arquivo de plug-in. A documentação da API é muito específica e fornece um excelente recurso para desenvolvedores que podem realizar perguntas avançadas. O material pode parecer difícil se você não estiver familiarizado com o PHP, mas leve seu tempo com os conceitos e as coisas começarão a fluir naturalmente!

A função abaixo deve ser adicionada diretamente após o comentário do cabeçalho do seu plugin. Alternativamente, isso também pode ser colocado dentro do seu tema. funções.php Arquivo. O código é usado para criar conteúdo de postagem dinâmico com base em um intervalo limitado de caracteres.

Assim, para o nosso exemplo, podemos limitar trechos da história apenas 55 caracteres com o hk_trim_content () função. Você pode chamar este código de maneira fácil a partir de um widget da barra lateral ou de um dos arquivos do seu tema para substituir $ the_content.

= $ limit) array_pop ($ conteúdo); $ content = implode ("", $ content). '...';  else $ content = implode ("", $ conteúdo);  $ content = preg_replace ('/\[.+\]/', ", $ content); $ content = apply_filters ('the_content', $ content); retorno $ content;?> 

Não se deve esperar que você entenda completamente todas as variáveis ​​internas ou funções usadas aqui. Basta ter uma compreensão geral de como suas funções devem ser escritas e como um conjunto de exemplos deve ser um ótimo começo.

Você também pode perceber que estamos usando uma chamada para apply_filters que é outra função específica do WordPress. Este é outro aspecto que você não precisa entender completamente, mas ajuda na programação futura do WP. Confira a página de referência apply_filters para mais detalhes e FAQs sobre o assunto.

A função principal acima é chamada hk_trim_content (). Isso requer apenas 1 parâmetro chamado limite de $. Isso também poderia ser encurtado para $ lim que deve armazenar um inteiro especificando quantos caracteres para limitar o seu trecho. O conteúdo é usado em post pages completas e também em páginas estáticas (sobre nós, contato).

Portanto, para chamar essa função, precisaríamos adicionar o parâmetro em nossos arquivos de modelo. Isso seria colocado em algum lugar possivelmente em seu index.php ou loop.php arquivo (s) e vai exigir que você instale o plugin primeiro. Exemplo abaixo:

Instalando e executando o plug-in

Eu criei um arquivo de exemplo para o plugin para demonstração, se você quiser pular o código. Simplesmente baixe este arquivo (renomeie-o para .php) ou copie / cole o código em um novo documento PHP e faça o upload para o seu / wp-content / plugins diretório.

Depois de concluído, você desejará acessar o painel de administração do WordPress e procurar seu conjunto atual de plug-ins para a demonstração que acaba de ser instalada. Uma vez que você ativar nada novo acontecerá, não até adicionarmos manualmente a nossa chamada de função. Para fazer isso basta navegar Aparência -> Editor e procure por single.php.

Este arquivo contém todo o modelo HTML / CSS para sua página de postagem de artigos básicos. Role para baixo até encontrar o conteúdo() e substitua pelo código de exemplo acima. Isso limitará todas as suas páginas de artigos a 55 caracteres, independentemente da exibição que estiver sendo usada. Você também pode adicionar essa função a páginas semelhantes no diretório de modelos, como search.php ou arquivo.php.

Conclusão

Estes são alguns dos princípios básicos para você começar a trabalhar no desenvolvimento do WordPress. O sistema de plugins é vasto e contém uma grande quantidade de funcionalidades internas. Se você já tem uma idéia para um plug-in, experimente em uma instalação local do WordPress para praticar estes tópicos..

Se você ainda está confuso com grande parte das informações, você pode revisar a documentação do WordPress e procurar sua resposta lá. A comunidade de desenvolvimento está cheia de usuários úteis e os fóruns mantêm arquivos com perguntas de anos atrás.