Написание своего плагина для WordPress. Часть 5. Размещение плагина в репозитории

После того как разработка плагина завершена можно предложить его для публикации в репозитории WordPress.

Если плагин будет добавлен в этот репозиторий, он станет доступным для установки из админпанели WordPress всем желающим владельцам и администраторам сайтов работающих на этой CMS.

Сам по себе процесс добавления плагина несложен.

Условно его можно разделить на четыре этапа.

  1. Подготовка плагина к добавлению;
  2. Подача заявки;
  3. Исправление ошибок если они есть;
  4. Публикация плагина.

Подготовка плагина к добавлению

Первым делом следует оформить соответствующим образом главный файл плагина. Для этого нужно включить в него информацию о плагине и лицензию. Как это делается подробно описано в части 1.

Далее требуется составить для плагина файл readme.txt в соответствии с установленным стандартом и сохранить его в корневую директорию плагина.

Составленный файл readme.txt  необходимо проверить на соответствии стандартам с помощью валидатора. Если он содержит ошибки, валидатор сообщит о них и их нужно будет исправить. Если ошибок нет, можно приступить к завершающей стадии подготовки.

А, именно упаковать файлы плагина в zip архив и разместить его в интернете таким образом, чтобы этот архив можно было скачать по прямой ссылке.

Подача заявки

Для того чтобы подать заявку нужно зарегистрироваться на сайте WordPress.org.

После регистрации можно будет перейти на страницу добавления нового плагина. На этой странице от Вас потребуется ввести название плагина, его краткое описание и прямую ссылку на архив с плагином.

Далее необходимо подождать пока Ваша заявка будет рассмотрена модераторами. Срок рассмотрения заявки зависит, в частности, от общего количества заявок. Однако обычно он не превышает одного-двух дней.

После рассмотрения заявки Вам сообщат о результате.

Возможны три варианта:

  • Заявка принята. Плагин прошёл проверку и можно публиковать его в репозитории;
  • Заявка не принята, так как плагин требует доработки. Плагин содержит ошибки или критические уязвимости и их необходимо устранить;
  • Заявка отклонена.

Исправление ошибок

Если плагин содержит ошибки или критические уязвимости, то Вам придёт письмо по email с просьбой их устранить. При этом, как правило, в письме также описана суть проблемы и прилагается ссылка на руководство по её устранению. Это значительно облегчает внесение исправлений.

Исправленную версию плагина следует снова запаковать в zip архив и отправить на повторное рассмотрение в ответном письме.

Крайне не рекомендуется затягивать процесс исправления, так как это может привести к отказу в размещении Вашего плагина.

Публикация плагина

Если плагин прошёл проверку и Ваша заявка принята, Вам на email придёт письмо со ссылкой на репозиторий для публикации плагина.

В репозитории WordPress используется система управления версиями SVN. Поэтому перед тем как размещать плагин будет полезно ознакомиться с основами работы в этой системе. Для пользователей операционной системы Windows лучше сразу же скачать и установить программу TortoiseSVN, которая на порядок облегчит работу.

Создаём отдельную директорию (папку) и в ней выполняем стандартное действие SVN Checkout.

SVN Checkout

В результате в данную папку из репозитория будет выгружена папка с названием директории SVN и четыре подпапки: assets, branches, tags и trunk. Для публикации необходимы только папки tags и trunk.

В папке tags хранятся подпапки со всеми версиями плагина. Чтобы добавить версию плагина нужно создать в ней подпапку с номером версии в названии (например, 1.0) и скопировать файлы плагина в неё.

Первая версия

В папке trunk хранятся файлы только последней (актуальной) версии плагина. Поэтому в данную папку просто скопируем нужные файлы плагина.

После этого можно выполнять непосредственно саму загрузку плагина в репозиторий.

Выполняем команду SVN Commit.

SVN Commit

В открывшемся окне создаём новый релиз с помощью сообщения «added version 1.0 of my plug-in»

SVNCommit диалоговое окно

После нажатия на кнопку «OK» плагин будет загружен в репозиторий WordPress. Если всё сделано правильно, то через несколько минут Ваш плагин будет доступен в репозитории WordPress по ссылке https://wordpress.org/plugins/my-plugin-name/.

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *