Одним из соображений, которые должны сделать все разработчики плагинов WordPress, является то, как на самом деле публиковать свои работы. Многие премиальные плагины предпочитают запускать свой собственный веб-сайт, документацию и шлюз покупки, но если вы хотите опубликовать бесплатный плагин или, возможно, облегченный вариант премиального плагина, тогда использование репозитория плагинов WordPress — отличный вариант.
WordPress.org предлагает управление исходным кодом, отслеживание статистики и автоматически уведомляет пользователей об обновлениях совершенно бесплатно. Не повредит и то, что сайт имеет хороший рейтинг в поисковых системах, тем более что ваш плагин может принести пользу!
В этой статье мы рассмотрим, как настроить репозиторий плагинов WordPress и поддерживать ваш проект в течение всего его жизненного цикла. Обратите внимание, что в этой статье предполагается, что вы знакомы с Subversion.
Шаг 1 Запрос доступа
Прежде чем запрашивать доступ к вашему проекту, вам необходимо иметь учетную запись на WordPress.org. Они бесплатны и просты в настройке.
Сначала перейдите на эту страницу и предоставьте запрашиваемую информацию. Как только ваша учетная запись настроена и подтверждена, вы можете настроить хранилище. Перейдите в Центр разработчиков WordPress. На домашней странице WordPress.org нажмите «Расширить и плагины». Затем нажмите «Добавить свой плагин:»
На следующем экране вам будет предложено ввести имя вашего плагина, краткое описание и URL-адрес домашней страницы проекта. Это не должно быть углубленным, но вот несколько советов, которые вам пригодятся при запросе доступа:
- Убедитесь, что имя плагина является окончательным. Как только вы получите доступ к хранилищу, вы не сможете изменить имя. Думайте стратегически о том, что вы хотите назвать плагин тоже. Для достижения наилучших результатов часто лучше всего назвать плагин чем-то простым, связанным с тем, что пользователи будут искать в поисковой системе.
- Не тратьте много времени на составление описания вашего плагина на этом этапе. Краткое описание одного предложения хорошо. Файл README для плагина предоставит более подробную информацию после запуска проекта.
- URL-адрес домашней страницы вашего плагина не обязательно должен быть действительным, но убедитесь, что любой указанный вами адрес находится там, где на самом деле будет жить домашняя страница плагина.
После того, как вы предоставили информацию, отправьте запрос. Вы получите электронное письмо с учетными данными для вашего хранилища, как правило, в течение 24-48 часов, после чего вы сможете сделать свой первый коммит.
Шаг 2 Настройка хранилища
После того, как вы получили URL хранилища, вы можете выполнить начальную проверку. Используя ваш любимый клиент Subversion (я использую TortoiseSVN в этом руководстве), выполните проверку, используя URL-адрес хранилища:
Это создаст каталог с именем плагина, который вы указали в первом шаге этого урока. Он также инициализирует ветви, теги и каталоги соединительных линий:
Краткое примечание о структуре каталогов:
- Магистраль хранилища — это ваш рабочий каталог. Это каталог, в котором вы делаете все ваши основные разработки.
- Теги — это версии или моментальные снимки ствола в определенных точках его цикла разработки. Часто вы можете пометить ствол каждый раз, когда хотите выполнить релиз.
- Каталог филиала — это копия магистрали в определенный момент времени, которая используется для интенсивной разработки. Если вы собираетесь заниматься тяжелой разработкой, лучше всего разветвляться — таким образом вы сохраняете качество ствола.
Вы можете прочитать намного больше о структуре каталогов Subversion здесь .
Шаг 4 Передача изменений
С этого момента вы можете начать работу с хранилищем. Если вы работаете с ним впервые, ваша директория транка должна быть пустой. Если вы работали над своим плагином до инициализации каталога, то теперь скопируйте файлы в ствол; в противном случае, не стесняйтесь начинать работать над своим плагином.
Когда вы закончите копирование или начнете работать над плагином, вам нужно будет добавить файлы в систему контроля версий. Для этого выполните команду add:
Это даст команду Subversion начать отслеживать эти файлы. Затем выполните команду commit:
Этот шаг фактически передает кодовую базу плагина в хранилище плагинов WordPress.
Конечно, вы еще не опубликовали свой плагин, пока не отметите его. Прежде чем сделать это, убедитесь, что вы правильно настроили заголовок вашего плагина и его файл README . Вы также можете прочитать больше об этом в серии статей «Ведение виджетов в WordPress» .
Шаг 3 Пометка и выпуск
Предполагая, что вы завершили рабочую версию своего плагина и настроили заголовок и README, пришло время выпустить версию вашего плагина. Для этого выполните команду Branch / Tag [TODO] в каталоге соединительных линий.
Перед этим убедитесь, что вы обновили тег версии в заголовке плагина:
И обновите стабильный тег README тоже:
Далее зафиксируйте изменения в стволе.
После этого вы готовы пометить:
При этом Subversion спросит вас, в каком каталоге вы хотите отметить версию. Очень важно, чтобы вы обновили путь плагина к пути тегов — большинство клиентов Subversion заполняют пункт назначения направлением магистрали. Это неверно — вместо этого вы захотите изменить путь на /tags/1.0 (но если вы пометите 1.5 или 2.0, вы измените число):
На данный момент, ваш плагин был проверен в системе контроля версий и помечен как определенная версия. В течение 20 минут ваш плагин должен появиться в хранилище плагинов WordPress по URL, который вы указали при запросе репозитория.
Проверка в будущих версиях плагина работает так же, как и в предыдущих шагах. Со временем вы сможете продолжить разработку плагина и отслеживать статистику загрузки со страницы проекта.
Вывод
Это оно! Надеемся, что к настоящему времени у вас есть хорошее понимание того, что требуется для официальной публикации вашего плагина через репозиторий плагинов WordPress. Недавно мы рассмотрели, как на самом деле начать создавать плагины … поэтому у вас должна быть прочная основа, чтобы выйти и начать создавать свои собственные плагины! Самое замечательное во всем этом — то, что оно помогает внести вклад в уже выдающуюся платформу WordPress. Чем больше талантливых разработчиков и дизайнеров мы сможем создать полезные плагины, тем лучше станет платформа!
Дополнительные ресурсы
Если вы хотите узнать больше о разработке плагинов для WordPress, посетите наши сервисы плагинов для WordPress в Envato Studio для получения дополнительных ресурсов и обучения по этой теме!