未分類

アップデートチェッカーとアップデートサーバー

アップデートチェッカーとアップデートサーバー

公式サイトのディレクトリに掲載していないプラグインとテーマは、自動アップデートを行う場合、自前で仕組みを用意する必要があります。もっとも使用されているのが、「 Plugin Update Checker 」ライブラリと、「 WP Update Server 」ライブラリです。これらを連携させる手順のメモです。

  • 公式サイトに掲載されているプラグインやテーマと同じように動作します。
  • アップデートが機能するには、プラグインまたはテーマがアクティブでなければなりません。
  • Plugin Update Checkerは、12時間ごとにURL先のバージョン情報をチェックします。
  • 新バージョンがある場合、WordPressダッシュボードにアップデート通知を表示します。

Plugin Update Checker v5.3

1. 「plugin-update-checker」フォルダを追加

プラグインまたはテーマのフォルダ内に「 plugin-update-checker 」フォルダを追加します。

2. プラグインの場合

plugin-slug.php
プラグイン内のplugin-slug.phpに以下のコードを追記します。青色部分は変更します。

require plugin_dir_path( __FILE__ ) . 'plugin-update-checker/plugin-update-checker.php';
use YahnisElsts\PluginUpdateChecker\v5\PucFactory;

$plugin_slug_UpdateChecker = PucFactory::buildUpdateChecker(
	'https://example.com/wp-update-server/?action=get_metadata&slug=plugin-slug',
	__FILE__,
	'plugin-slug'
);

3. テーマの場合

functions.php
テーマ内のfunctions.phpに以下のコードを追記します。青色部分は変更します。

require get_theme_file_path( '/plugin-update-checker/plugin-update-checker.php' );
use YahnisElsts\PluginUpdateChecker\v5\PucFactory;

$theme_slug_UpdateChecker = PucFactory::buildUpdateChecker(
	'https://example.com/wp-update-server/?action=get_metadata&slug=theme-slug',
	__FILE__,
	'theme-slug'
);

WP Update Server v2.0.1

1. wp-update-serverフォルダをサーバーにアップロード

「 wp-update-server 」フォルダをレンタルサーバーにアップロードします。

2. プラグインまたはテーマのZIPファイルをアップロード

「 wp-update-server / packages 」フォルダ内に、プラグインのZIPファイル、またはテーマのZIPファイルをアップロードします。

3. プラグインの更新情報を表示

readme.txt
プラグイン制作のガイドラインに沿って、プラグイン内にreadme.txtを含めます。
アップデート時に「プラグイン情報ページ」として表示されます。

4. テーマの詳細情報を表示

style.css
テーマ内のstyle.cssのコメント欄に、以下の一行を追記します。青色部分は変更します。
アップデート時に「バージョンの詳細を表示」のURLとして表示されます。

Details URI: http://example.com/update-info/

5. プラグインのバナー画像とアイコン画像をアップロード

「 wp-update-server / package- assets / banners」フォルダ内に、バナー画像(プラグイン用)、「 wp-update-server / package- assets / icons 」フォルダ内に、アイコン画像(プラグイン用)をアップロードします。名前とサイズは以下のようにします。青色部分は変更します。

bannersフォルダ
plugin-slug-771x250.png

iconsフォルダ
plugin-slug-256x256.png

その他の情報

「 theme update checker 」ライブラリについて
2017年に、「 theme update checker 」ライブラリは非推奨となりました。代わりに、テーマにも「 plugin-update-checker 」ライブラリの使用が推奨されています。

ダウンロードリンクの保護について
このブログ記事を参照してください。

アクセス解析について
wp-update-server-statsツールを使用すると、サーバーログを解析し、アクティブなインストール数やアクティブなバージョンなどの統計情報を表示できます。

ライセンス管理機能
現在のところ、Plugin Update Checkerにはライセンスキーを管理する機能はありません。

Plugin Checkerプラグインでエラー
Plugin Checkerプラグインでチェックすると、Plugin Update Checker v5.3はコードに問題があるエラー出ます。

この記事を書いた人

Colors Themes

無料のWordPressテーマ「Clock」と、多目的タイプのWordPressテーマ「Silent」の開発者です。