Como enviar plugins para o repositório WordPress.org

Publicados: 2021-06-02

Hospedar um plugin no repositório WordPress.org é uma das formas mais populares (e eficazes) de iniciar um negócio freemium de sucesso. Se for a primeira vez que você envia um plug-in para o repositório, algumas das etapas podem não ser claras ou confusas, e é por isso que descrevi o processo para orientá-lo. Eu também recomendo marcar esta página se você precisar fazer referência a ela no futuro.

Preparando para submissão

Primeiro, você precisa obter a aprovação da equipe de revisão do plug-in para hospedar seu produto no repositório. Para isso, você precisa ter uma conta no WordPress.org. Não tem um? Não se preocupe - você pode se registrar aqui.

Criando o arquivo Readme.txt do plugin

Em seguida, você precisa criar um arquivo readme.txt formatado com markdown que será usado para a página de listagem do seu plug-in no WordPress.org. Ele precisa conter as seguintes informações:

Nome do plug-in
Colaboradores (seu ID de usuário do WordPress.org)
Tags de plug-in
Requer pelo menos (versão WordPress)
Testado até (versão WordPress)
Tag estável (versão do plugin)
Licença (GPLv2 ou posterior)
Licença URI: www.gnu.org/licenses/gpl-2.0.html
Descrição (descrição completa do seu plugin)
Perguntas frequentes
Capturas de tela
Registro de alterações

Para referência, aqui está um modelo de arquivo readme.txt padrão.

Para garantir que você formatou e estruturou o arquivo readme.txt do seu plugin corretamente, use o WordPress Readme Validator.

Escolha o nome do seu plug-in com cuidado

É importante que você reserve um tempo para escolher o nome do plug-in “certo” antes do envio inicial, pois isso afetará a URL da listagem do seu plug-in, o que afetará o SEO da sua listagem do WordPress.org e, eventualmente, a exposição orgânica e o crescimento do plug-in.

Aqui está a seção relevante que cobre o impacto do nome na página de envio do plug-in:

O URL do seu plug-in será preenchido com base no valor do Plugin Name -in em seu arquivo de plug-in principal (aquele com os cabeçalhos do plug-in). Se você definir o seu como Plugin Name: Boaty McBoatface , sua URL será https://wordpress.org/plugins/boaty-mcboatface e seu slug será boaty-mcboatface por exemplo. Se houver um plugin existente com seu nome, você será boaty-mcboatface-2 e assim por diante. Ele se comporta exatamente como os nomes dos posts do WordPress.

Então, quando você escolher o nome inicial, pense em otimizá-lo para SEO em vez de branding. Pergunte a si mesmo quais palavras-chave você gostaria de segmentar e extrapole o nome delas. Você pode encontrar algumas dicas de nomenclatura aqui.

Lembre-se, você sempre pode alterar o nome do plugin após o envio inicial – portanto, mesmo que você escolha um nome que não goste, poderá alterá-lo posteriormente (e quantas vezes desejar). O que você não pode mudar é o slug do plugin, portanto, a nomenclatura inicial é importante.

Observe também que o slug é criado a partir do nome do plug-in em seu arquivo de plug-in principal, que pode ser diferente do valor do nome do plug-in no arquivo readme.txt.

Enviando seu plug-in

Depois de escolher um bom nome de SEO – e seu plug-in e arquivo readme.txt estiverem prontos – vá para a página Adicionar seu plug-in e envie-o para revisão.

O processo de revisão é manual e pode levar de 1 a 10 dias, dependendo da fila de revisão e da complexidade do seu plug-in. Se algum problema for encontrado, você receberá um e-mail detalhando esses problemas e como você pode corrigi-los.

Assim que os problemas forem resolvidos (se houver), você receberá a aprovação por e-mail. Seu plugin não é público neste momento, mas você ainda pode fazer upload, editar e excluir arquivos por meio da linha de comando ou de um cliente SVN.

Dica: para garantir que você não perca e-mails importantes, recomendo colocar na lista de permissões [email protected] , o endereço de e-mail usado pela equipe de revisão de plug-ins do WordPress.org para comunicação com os desenvolvedores de plug-ins.

Carregando o plug-in

Agora que você recebeu acesso ao repositório SVN, o próximo passo é enviar seu plugin para o repositório WordPress.org. Antes de fazer isso, recomendamos que você se familiarize com os fundamentos do uso do Subversion com o WordPress.

Estou indo com a interface de linha de comando para este tutorial. Se você não é fã dele e prefere trabalhar com um cliente visual, considere TortoiseSVN para Windows e Cornerstone para Mac.

Antes de enviar os arquivos do plugin para o repositório SVN, você precisa criar uma pasta local onde os arquivos e ativos serão armazenados. Este comando criará um diretório local:

$ mkdir my-awesome-plugin

Para consistência, é uma boa prática nomear a pasta e o arquivo PHP principal do plugin de acordo com o slug que você recebeu após o envio inicial. Neste exemplo, presumo que o nome do seu plugin seja My Awesome Plugin e seu slug aprovado seja my-awesome-plugin .

Agora, para ver e baixar o repositório pré-construído:

$ svn checkout https://plugins.svn.wordpress.org/my-awesome-plugin local/path/to/my-awesome-plugin

Isso dará o seguinte retorno:

A my-awesome-plugin/branches
A my-awesome-plugin/tags
A my-awesome-plugin/trunk
Checked out revision #####

Aqui, A significa que os diretórios foram adicionados à pasta local do repositório central. Em seguida, você precisa copiar os arquivos e pastas do seu plugin para a pasta trunk :

$ rsync -r local/path/to/wordpress/wp-includes/plugins/my-awesome-plugin/* local/path/to/my-awesome-plugin/trunk

E adicione-os ao repositório.

$ svn add trunk/*

Em troca, você será solicitado a se autenticar. Assim que estiver logado, você receberá uma resposta parecida com esta:

A trunk/my-awesome-plugin.php
A trunk/readme.txt

Importante: o WordPress.org trata a pasta trunk como a pasta de nível superior do seu plugin. Portanto, não copie toda a pasta do plugin como está, o trunk deve incluir apenas o conteúdo do plugin.

Evite isso: trunk/my-awesome-plugin/my-awesome-plugin.php

Depois de adicionar todos os arquivos, confirme as alterações de volta no repositório central:

$ svn commit -m 'My first plugin version'

Isso retornará a seguinte resposta:

Adding trunk/my-awesome-plugin.php
Adding trunk/readme.txt
Transmitting file data.
Committed revision 9999999.

Para fazer upload de um ícone de plug-in, banner e capturas de tela, você pode criar uma nova pasta de ativos em seu repositório local SVN:

$ mkdir local/path/to/my-awesome-plugin/assets

Você pode aprender como os ativos de plug-in funcionam aqui.

Depois de ter seus ativos prontos, adicione os ativos do plug-in ao repositório SVN:

$ svn add assets/*

Confirme as alterações novamente:

$ svn commit -m 'Assets upload'

É isso! Seu plugin já está disponível para download e você pode começar a promovê-lo.

Publicando uma nova versão

Para a próxima versão de atualização do seu plug-in, as etapas são um pouco diferentes. Antes de publicar a nova versão, atualize o campo Stable Tag no trunk/readme.txt file e o número da versão no comentário do cabeçalho do plug-in. Depois de ter seus arquivos de plug-in prontos, copie-os para uma subpasta de /tags e defina o nome da subpasta para a nova versão, como 1.0.1 .

$ svn copy trunk tags/1.0.1

  A tags/1.0.1

Confirme as alterações.

$ svn commit -m 'Version 1.0.1 release'

  Adding tags/1.0.1
  Adding tags/1.0.1/my-awesome-plugin.php
  Adding tags/1.0.1/readme.txt
  Committed revision 999999.

E pronto, a nova versão do seu plugin está pronta!

Dicas de gerenciamento de versão

Você pode notar algum atraso desde o momento de lançar uma nova versão e quando ela estiver disponível para download na página de listagem de plugins do WordPress.org. Aguarde algumas horas e, se ainda não o vir, envie um e-mail para [email protected] , pois o sistema apresenta problemas de tempos em tempos.
Como regra geral, para reduzir problemas de sincronização, é recomendável que a versão do plug-in em sua pasta de trunk seja idêntica à versão do plug-in em sua versão mais recente na pasta de tags .

Qual é o próximo?

Por natureza, os desenvolvedores de plugins gratuitos são motivados e apaixonados por contribuir com coisas úteis para o mundo. Acima de tudo, queremos que nossos produtos resolvam problemas específicos que as pessoas possam ter. Mas independentemente de quão grande seja o seu plugin, não será de muita ajuda se as pessoas não conseguirem encontrá-lo.

Um bom próximo passo para melhorar a visibilidade do seu plugin gratuito é otimizar o arquivo readme.txt para SEO, que é algo que exploramos aqui.

Se você está pensando em ganhar dinheiro com seu plugin, não basta ter seu produto online de graça – você quer que as pessoas o descubram, usem, adorem e (espero) atualizem para sua versão paga! Hoje em dia, um desenvolvedor WordPress usa muitos chapéus, de fabricante de produto a proprietário de empresa e comerciante, e para que seu plug-in seja visto pelas pessoas certas, você precisa desenvolver e refinar suas habilidades de marketing.

Que é um assunto que exploramos em profundidade com o nosso Manual de Marketing para Criadores de Produtos WordPress. Eu também recomendo verificar a folha de dicas abaixo para vender plugins e temas do WordPress – é um roteiro conciso e acionável para criar um negócio WordPress de sucesso, desde a idealização até o lançamento e o crescimento.

Pegue uma cópia gratuita do nosso

Folha de dicas para vender temas e plugins

Um roteiro de crescimento com dicas concisas e acionáveis para cada marco do desenvolvimento de produtos WordPress.

Grato pela assinatura!

- acabamos de enviar sua cópia do 'Cheat Sheet for Selling Themes and Plugins' para .

Tem um erro de digitação no seu e-mail? clique aqui para editar o endereço de e-mail e enviar novamente.

Você está planejando enviar um plugin para o repositório WordPress.org? Você está pensando em usar o modelo de negócios freemium? Som desligado nos comentários abaixo!