← All posts

Adding a Plugin to the WordPress.org Plugin Directory

WordPress logo

I added the Yandex.Fotki plugin to the WordPress.org plugin directory: http://wordpress.org/extend/plugins/yandex-fotki/. And I decided to share how to do it, step by step…

To add a plugin (and for other things, too), you first need to register on WordPress.org. Once you have registered, you need to log in to the site.

Adding a Plugin

To add a plugin, follow the link http://wordpress.org/extend/plugins/add/ and fill out the form fields.

At the moment, the WordPress site does not support Russian in plugin names, converting it to hex code (%20%68…), so use an English name.

After submitting, you will be able to access the plugin’s page, but you cannot edit anything there, because all changes are made through SVN.

You will have to wait a few hours for your submission to be reviewed and for the access details for your plugin’s SVN repository to be sent to you.

Working with the SVN Repository

Let’s get started setting up your repository:

  • Do a checkout (the link will be sent to you by email).
  • Create a subdirectory called “release-1.0” in the “/tags” directory, where 1.0 is your plugin’s version.
  • Copy the plugin’s source files into the “/tags/release-1.0” and “/trunk” directories.

Additional information: http://wordpress.org/extend/plugins/about/svn/

Writing and Validating the README.TXT File

Alongside the source code, you need to upload a “README.TXT” file (case does not matter). This file is intended to describe your file in wiki format and has the following main sections:

=== Название плагина ===
Contributors: автор
Tags: теги через запятую (пример: yandex, photos)
Stable tag: Номер стабильной версии (я ставлю "trunk")

Тут маленькое описание, используется в результатах поиска и в списке плагинов.

== Description ==

Полное описание...

= Подпункт =

...продолжение описания.

== Installation ==

Процедура установки

<code>
код
< /code>

== Frequently Asked Questions ==

Факу

== Screenshots ==

Скриншоты выводить так:

1. layout 1
2. layout 2

При этом необходимо залить в каталог с исходными кодами картинки в формате "png, jpg, gif"
и с названием "screenshot-1.png" и "screenshot-2.png".

== Changelog ==

Список версий и изменений.

Example file http://wordpress.org/extend/plugins/about/readme.txt
Official validator http://wordpress.org/extend/plugins/about/validator/

After svn-commit, at least 15 minutes must pass before your plugin’s information is updated in the directory. You can also find some answers to your questions in the FAQ: http://wordpress.org/extend/plugins/about/faq/

Comments are closed. Read the original discussion in Russian →