Этот класс предназначен для использования с вашими плагинами WordPress, размещенными на GitHub. Цель этого класса – позволить вашему плагину WordPress обновляться всякий раз, когда вы выпускаете новую версию своего плагина, аналогично тому, как пользователи знают и любят хранилище плагинов WordPress.org.
Не все плагины могут или должны быть размещены в хранилище плагинов WordPress.org, или вы можете разместить его и на GitHub.
Этот класс был первоначально разработан Йоахимом Кудишем, но поскольку у него не было возможности обновить его через некоторое время, radishconcepts взялись за его дальнейшую судьбу. Так же radishconcepts используют этот класс в паре собственных плагинов (dogfooding!) И будут продолжать развивать (по их заявлениям).
Инструкция по применению
- Класс должен быть включен где-то в ваш плагин. Вам потребуется файл (пример:):
include_once('updater.php');
. - Вам нужно будет инициализировать класс, используя что-то похожее на это:
-
В вашем репозитории GitHub вам нужно будет включить следующую строку (отформатированную точно так же) в любом месте вашего файла Readme:
~Current Version:1.4~
-
Вам нужно будет обновлять номер версии каждый раз, когда вы обновляете плагин, это в конечном итоге позволит плагину узнать, что доступна новая версия.
-
Начиная с версии 1.6, программа обновления также может выбрать версию из заголовка плагина.
-
Поддержка частного репозитория была добавлена в v1.5
Важные изменения
1.6 (в разработке)
- Получить версию из заголовка плагина вместо readme с поддержкой обратной совместимости для readme, добавленной @ninnypants
- Лучшие способы обработки вызовов GitHub API и способ хранения данных благодаря @coenjacobs
- Следуйте стандартам кода WordPress и удаляйте конечные пробелы
- Исправить уведомление PHP на экране администратора плагинов, props @ninnypants
- Используйте центральную функцию для построения запроса, используемого для взаимодействия с GitHub API, props @davidmosterd
1,5
- Добавлена поддержка частных репозиториев @pdclark.
- Дополнительное исправление sslverify
Источник записи: https://github.com