Посібник з публікації вашого плагіна в WordPress Plugin Directory

2001 року Michel Valdrighi представив новий інструмент для створення блогів — b2/Cafelog, а вже 2003 року на його основі Matt Mullenweg та Mike Little створили платформу WordPress. Згідно з офіційним сайтом WordPress.org — WordPress з'явився завдяки нашим спільним бажанням створити елегантну, добре спроектовану систему для персональних публікацій, написану на PHP та MySQL під ліцензією GPL.

Дивіться також:

• Що таке Плагіни WordPress та як їх встановлювати
• Майбутнє WordPress плагінів: Що на нас чекає у 2016 році?
• Посібник з вибору найкращих WordPress плагінів
• 9 базових must-have плагінів для будь-якого нового сайту на WordPress

У 2004 році було введено плагіни для розширення функціональних можливостей ядра WordPress. Ось як виглядала офіційна бібліотека WordPress плагінів у листопаді 2004 року:

На той момент було зареєстровано лише 46 плагінів. Зараз, через дванадцять років, їх кількість досягла майже 44 тис. із загальним числом завантажень понад 1,2 млрд.

Ось як виглядає Каталог плагінів WordPress зараз:

Сьогодні ми детально розглянемо процес додавання плагінів у каталог WordPress, поділимося корисними порадами, ґрунтуючись на нашому власному досвіді, та опишемо покрокові інструкції для розміщення плагіну у центральному сховищі Subversion для користувачів Mac та Windows.

Навіщо публікувати свій WordPress плагін?

Звичайно, кожен автор має свої причини для публікації плагіна в каталозі WordPress. Ось кілька із них:

• ви бачите необхідність якоїсь функції, якої ще не існує у вигляді плагіна в каталозі
• ви хочете, створити спільноту навколо вашого продукту
• ваш улюблений плагін не пропонує додаткові функціональні можливості, які ви хотіли б мати
• ви обурені тією вартістю, яку деякі розробники плагінів вимагають за аддони та розширення, і думаєте, що могли б створити щось подібне за нижчою ціною
• ви хочете спростити якийсь існуючий плагін
• ви хочете зробити свій внесок у розвиток WordPress і стати частиною спільноти

Наочний приклад

Свого часу розробники плагіна WPMerchant були незадоволені вартістю eCommerce плагінів та їх складністю. Діти дійшли рішення, що було б круто спростити весь процес електронної комерції, а також запропонувати нижчі ціни, щоб за їх допомогою кожен бажаючий міг створити свій інтернет-магазин. Після таких роздумів компанія вирішила створити свій eCommerce плагін WPMerchant.

Процес подачі плагіна до каталогу WordPress.org

Ми постаралися розбити весь процес на окремі дрібні етапи і детально їх описали. Всі дії представлені в тому порядку, в якому ми їх робили.

1. Прочитайте Посібник

Заощаджуйте собі час і гроші та уважно прочитайте це керівництво перед тим, як зберетеся відправляти плагін. Переконайтеся, що продукт відповідає всім вимогам. Ось лише деякі з них:

• Плагін підпадає під ліцензію GPL
• При розміщенні інформації користувачів потрібна наявність згоди користувача
• Немає спаму
• Немає обфузованого коду
• Немає жодних дій, які є незаконними чи образливими
• Немає вкладених зовнішніх посилань на публічні сайти

2. Перевірте ім'я плагіна у каталозі WordPress

перейдіть на wordpress.org/plugins та введіть потрібне ім'я плагіна у рядок “Search plugins…”

Навіть якщо збігів немає, є шанс, що плагін із подібним ім'ям вже існує, просто користувач ще не підтвердив свій перший Subversion commit. Тому потрібно якнайшвидше зробити всю роботу з додаванням плагіна в каталог, щоб ім'я дісталося все-таки вам. Якщо плагін із таким ім'ям вже існує, збирайтеся з силами, починайте "мозковий штурм" і вигадуйте нову назву.

3. Створіть плагін, який працює

Ми створили наш плагін за допомогою фреймворку WordPress Plugin BoilerPlate. Це зручний та якісний інструмент.

На сайті SitePoint є низка корисних статей, які допоможуть вам розібратися в процесі розробки плагінів за допомогою WordPress Plugin Boilerplate:

• Speed ​​up Development За допомогою WordPress Plugin Boilerplate
• WordPress Plugin Boilerplate Part 2: Розробка Plugin
• The WordPress Plugin Boilerplate Part 3: The Last Steps

Після створення необхідно оновити код і кілька разів протестувати найменші деталі, щоб переконатися, що все працює належним чином.

4. Файл Readme

Файл ReadMe використовується для заповнення сторінки плагіна у директорії WordPress. Якщо ви хочете, щоб все виглядало справді круто, зверніть увагу на статтю Jérémy Heleine "Creating Awesome WordPress.org Pages for your Plugin".

Якщо коротко, то ви повинні написати ім'я плагіна, творців (ваш ID автора в WordPress), прикріпити теги, вказати необхідну версію WordPress, ліцензію (має бути GPL) та короткий опис вашого плагіна. Вибираючи теги, подивіться, що задали ваші конкуренти. Також використовуйте найпопулярніші теги, які стосуються вашого плагіна.

Після додавання цієї інформації додайте основний опис, інструкції з встановлення, запитання (FAQ), що часто ставляться, і скріншоти роботи вашого плагіна. Чим більше скріншотів, тим краще. Після того, як ви всі додали і залишилися задоволені виконаною роботою з файлом, запустіть його через ReadMe Validator. Якщо все зроблено правильно, ви побачите таке:

5. Подайте свій плагін на розгляд

Після того, як ви зробили все сказане вище, потрібно подати свій плагін на перевірку.

Для початку необхідно створити обліковий запис WordPress:

Далі перейдіть за посиланням wordpress.org/plugins/add

Додати ім'я плагіна, а також його опис. У рядок URL плагіна вам необхідно скинути посилання на архів з усіма файлами плагіна. Відповідний zip-файл можна завантажити на Dropbox або Google Drive, або будь-який інший сайт, до якого у вас є доступ.

6. В очікуванні відповіді

Всі WordPress плагіни переглядаються вручну, тому перш, ніж ви отримаєте відповідь, має пройти якийсь час. У нашому випадку цей процес зайняв близько восьми годин.

7. схвалення

Вітаємо, якщо ви отримали подібний лист, значить вашу плагін схвалили!

8. Додавання плагіна в WordPress Subversion Repository

Subversion – це інструмент для керування версіями, який дозволяє відстежувати всі зміни, що відбуваються з вашим плагіном, переглядати та навіть переходити назад на старі версії. Якщо ви вже знайомі з Git (інша подібна система керування версіями), ви розберетеся дуже швидко.

Тепер, коли вашу плагін схвалили, настав час зберігати його копію в WordPress Subversion repository. Це сховище, де файли вашого плагіна зберігатимуться. Будь-яка людина може отримати копію файлів, але тільки автор може вносити зміни.

Далі ми маємо два варіанти інструкцій для додавання плагіна в WordPress Subversion repository. Перший варіант для користувачів Mac, другий для тих, хто використовує Windows.

Для Mac

Ми збираємося зберегти свій плагін у репозиторії WordPress за допомогою командного рядка. Відкрийте термінал. Знайдіть батьківський каталог, де ви хочете розмістити вашу плагін.

• використовуйте команду cd 'directory name' щоб відкрити каталог
• використовуйте команду CD .. щоб перейти з поточного каталогу до батьківського каталогу
• використовуйте команду лс-а для отримання списку всіх файлів та каталогів у поточному каталозі

Коли ви перейдете до батьківського каталогу, виконайте наступну команду (svn - Це скорочення для Subversion, co - Для checkout).

$ svn co https://plugins.svn.wordpress.org/wpmerchant wpmerchant

Ця команда додає всі файли з вашого центрального сховища до локального. Не забудьте поміняти https://plugins.svn.wordpress.org/wpmerchant на URL, який прийшов вам у вашому email із схваленням плагіна, він має бути у форматі https://plugins.svn.wordpress.org/your-plugin- name. Також наприкінці команди потрібно замінити wpmerchant на вашу назву каталогу (щоб не морочитися, можна просто вибрати ім'я плагіна).

Далі ви отримаєте відповідь з такими варіантами:

(R)eject, accept (t)emporarily or accept (p)ermanently?

R - відхилити, t - прийняти тимчасово, p - прийняти постійно. Введіть t або p та натисніть Enter. Повідомлення, які ви отримаєте після цього, вказує на те, що ваш каталог був створений і що до нього додані окремі каталоги "tags", "assets", "trunk" і "branches".

A wpmerchant/tags
A wpmerchant/assets
A wpmerchant/trunk
A wpmerchant/branches
Checked out revision 111111.

Помістіть усі ваші файли в каталог ствол. Далі ці файли потрібно додати і репозиторій Subversion, щоб їх можна було відстежувати. Зробити це можна, ввівши наступний рядок у термінал:

$ svn add trunk/*

Збережіть зміни (штовхати), виконавши наступну команду:

$ svn ci -m 'Adding first version of my plugin'

Вам потрібно буде ввести логін та пароль користувача на вашому комп'ютері. Потім потрібно ввести ім'я користувача та пароль у WordPress. Після того, як це буде виконано, файли будуть передані до центрального репозиторію WordPress. З'явиться таке повідомлення:

Готово! Тепер ви повинні отримати електронною поштою лист від WordPress. Можемо переглянути сторінку нашого плагіна у каталозі WordPress.

Як ви бачите, немає ні банера нагорі сторінки, ні скріншотів, які ми хотіли розмістити. Що ми зробили не так? Ми не додали наші зображення до каталогу активи. Переконайтеся, що ви помістили всі потрібні зображення в папку assets і виконайте наступну команду в терміналі:

$ svn add assets/*

Збережіть зміни у центральному сховищі:

$ svn ci -m 'Adding assets directory images'

Можете перевірити сторінку плагіна, тепер все має відображатися належним чином:

Якщо ви розробляєте плагін на кількох комп'ютерах або використовуєте різних авторів, переконайтеся, що ви виконуєте команду оновлення (див. нижче), перед будь-якими змінами. Це витягне ті зміни, які ви робите у центральному сховищі, у ваше локальне (тягнути).

$ svn up

Для PC

Для того, щоб опублікувати свій плагін на комп'ютері з Windows, необхідно завантажити сумісну версію клієнта Subversion. Черепаха SVN - Це популярний вибір. Завантажте та встановіть цей клієнт.

Після інсталяції відкрийте Провідник Windows. Перейдіть до папки, куди ви хочете зберегти ваш репозиторій WordPress SVN, натисніть на цю папку, а потім клацніть правою кнопкою мишки по її іконці.

Натисніть меню SVN Checkout.

Введіть URL-репозиторія, який отримали в листі від WordPress електронною поштою. URL має бути у форматі https://plugins.svn.wordpress.org/your-plugin-name. Натисніть кнопку OK.

Цей скріншот підтверджує, що все зроблено правильно. Усі файли та каталоги, які існують у центральному сховищі WordPress, були завантажені на ваш комп'ютер у папку, яку ви вказали.

Тепер у тій папці, яку ви вибрали, знаходяться нові папки: assets, trunk, branches та tags. Вам потрібно додати всі ваші файли плагіна до папки ствол. Потім необхідно відкрити провідник Windows, натиснути на іконку SVN і клацнути правою кнопкою мишки.

Натисніть на Комісія SVN. Наступний скріншот показує різні файли, які були додані та змінені у SVN-репозиторії. Переконайтеся, що прапорці стоять лише поряд із тими файлами, які потрібно відстежувати у сховищі. Також переконайтеся, що всі файли будуть додані до центрального сховища WordPress.

Натисніть кнопку OK. Тепер усі файли повинні існувати і в центральному сховищі WordPress SVN, і на локальному комп'ютері. Якщо ви працюєте на кількох комп'ютерах, не забудьте запустити функцію Оновлення SVN для синхронізації локального репозиторію із центральним сховищем WordPress.

Для цього увійдіть у провідник Windows, знайдіть вашу папку SVN, і клацніть правою кнопкою мишки по її іконці:

Натисніть на функцію Оновлення SVN. Так, ваша копія сховища буде такою ж, як і в центральному сховищі WordPress.

Висновок

Це все, що потрібно зробити. Сподіваємося, що ця інформація виявилася для вас корисною. Залишайте свої відгуки у коментарях.

Джерело: sitepoint.com

Олексій Шевченко

редактор wpcafe

Вивчає сайтобудування з 2008 року. Практикуючий вебмайстер, що спеціалізується на створенні сайтів WordPress. Задати питання Олексію можна на https://profiles.wordpress.org/wpthemeus/