Objota O mundo orientado a objetos

Como criar plugins para wordpress – Parte 4 – publicando seu plugin

Posted on janeiro 29, 2011

Como publicar seu plugin no wordpress.org

Neste artigo veremos os passos necessários para se publicar seu plugin no wordpress.org, site oficial do WordPress.

1º - Caso não tenha um cadastro em wordpress.org, registre-se. Pois é preciso estar logado para solicitar um repositório SVN para você. E uma vez que tenha registro seus plugins serão associados ao seu perfil de usuário do wordpress, o mesmo se aplica caso venha a publicar temas.

2º - Licença, caso você não inclua um arquivo de licença (licence.txt) junto ao seu plugin, será considerado pelo wordpress.org que você assumiu a licença GPL2.

3º - É obrigatório incluir o arquivo readme.txt junto ao seu plugin, pois todas as informações da página de seu plugin serão estraídas dele.

4º - Uma vez pronto, testado e funcionando você poderá solicitar a criação de um diretório SVN para seu plugin. Com este diretório será possível você disponibilizar e manter organizado todas as versões de seu plugin. Inclusive enviar versões como beta (em fase de desenvolvimento e teste).

Para isso será necessário manter seu plugin online em algum lugar e enviar uma solicitação através de um formulário como este, informando nome do plugin, breve descrição do que ele faz e a URL para baixar o seu plugin.

Página de solicitação

obs: para isso é preciso estar logado.

Você receberá um email de confirmação do wordpress.org, neste email constará o endereço de seu SVN a senha de acesso para ele será a mesma de acesso  ao seu perfil no wordpress.org.

5º - Baixar um software para gerenciar seu diretório SVN. Eu utilizo o Tortoise.

Entendendo o readme.txt

Este documento é muito importante, deve ficar na raiz do diretório de seu plugin. Como dito antes, as informações que nele constar serão utilizadas para preencher e formar a página oficial de seu plugin no wordpress.org.

Cada aba das páginas de plugin provem deste arquivo, exemplo: description, faq, changelog, screenshots e etc.

Esta página é destinada aos desenvolvedores: Developer Center

Ainda nela é possível ver os links para faq, informações sobre subversion (SVN) e uma página que contém um exemplo do formato padrão do readme.txt e logo abaixo um link para o validador do readme.txt. É muito importante validar seu arquivo, pois caso haja algum erro crítico seu plugin pode não ser publicado corretamente ou talvez nem seja publicado.

SESSÕES DO README.TXT

=== Título do plugin ===

Contributors:
Nome dos contribuidores...

Donate link:
link para possíveis doações

Requires at least: 3.0
mínima versão requerida do wordpress

Tested up to: 3.0.1
versão do wordpress em que o plugin foi testado

Stable tag: 1.2
Versão estável do plugin

Tags:
palavras chaves que tenham relação ao plugin, são apenas para fim de indexação e busca.

== Descritption ==

descrição do plugin

== Installation ==

descrição da instalação

== Frequently Asked Questions ==

= Pergunta é destacada desta forma =
A resposta vem logo embaixo.

== Upgrade Notice ==

1.2 Nesta nova versão temos uma super novidade.

== Screenshots ==

1. Aqui é a descrição da primeira screenshot. A imagem vai na raiz do plugin seu nome deve ser screenshot-1, screenshot-2 e etc..

2. Aqui vem a descrição da segunda screenshot

== Changelog ==

= 1.2 =
* Esta nova versão foram feitos os melhoramentos de....

= 1.1 =
* Este é primero melhoramento no gerenciamento de...

------------
para fazer um link dentro de uma sessão

[texto do meu link](http://www.destinodomeulink.com.br)

Utilizando o Tortoise

Depois de criado seu repositório e validado seu readme.txt, já podemos então publicá-lo. Para isso vamos primeiro para fim de organização criar na máquina local, um diretório plugins_wordpress, dentro deste diretório vamos criar um diretório com o mesmo nome do nosso plugin. Vou supor que o nome do plugin seja Meu WP, provavelmente o meu plugin terá o seguinte nome de diretório meu-wp.

Agora, selecione a pasta e clique com o botão direito, no menu de contexto irá aparecer:

Clique na opção SVN Checkout e será iniciado um download da estrutura de diretórios de seu SVN, será copiado tudo o que tem lá (no momento só os diretórios).

Para isso você precisa informar o diretório SVN online:

Concluído isso você terá a seguinte estrutura de diretórios ( o nome meu-wp é só um exemplo):

Explicando

Diretório trunk – Neste diretório irá ficar a versão disponível para download.

Diretório tags - Neste diretório serão incluídos todas as verões de seu plugin. Atenção o diretório tags trabalha juntamente com trunk. (vejamos adiante).

Diretório branches – Neste diretório ficam versões não oficiais (Em desenvolvimento ou teste).

O diretório trunk e tags trabalham juntos, portanto vamos supor que minha versão seja a 1.0, então devo colocar os arquivos de meu plugin na pasta trunk e criar um diretório dentro de tags como nome 1.0 e dentro dele colocar o mesmo conteúdo de trunk.

Nota: Aqui se vê a importância de informar a Stable tag no documento readme.txt. Portanto se a minha versão atual é a 1.0, em meu documento preciso informar que a Stable tag é a 1.0.

Certifique-se também de que o cabeçalho do plugin no aquivo principal esteja informando a versão correta do plugin – (isso é geralmente o mais fácil de esquecer).

Estes passos são necessário toda vez que for atualizar seu plugin, (recaptulando):

  • Atualizar seus arquivos na pasta trunk
  • Criar um diretório , dentro do diretório tags, como mesmo nome da minha versão atual e nele depositar o conteúdo da pasta trunk.

Fazendo isso, não terá problemas.

Sincronizando com seu SVN

Depois de feita todas as devidas alterações é só sincronizar. Para isso clique no diretório local de seu plugin, clique com o direito e no menu de contexto irá aparecer a opção Commit. Clique nele e  o processo irá iniciar, neste meio ele irá solicitar login e senha (são os mesmos de seu perfil no wordpress.org) informe-o e siga em frente.

Ele irá atualizar seu repositório, mesmo assim existe uma diferença de alguns minutos para que sua página seja atualizada a seu plugin disponibilizados. Talvez certa que 15 minutos.

Depois disso é só aguardar e verificar a página de seu plugin.

É isso pessoal a série termina aqui, espero que tenham curtido. Até a próxima, duvidas sugestões.. fiquem a vontade para comentar.

Posted by Rodrigo Ireno