「NPUSWC Client」の使い方 – 開発者

プラグイン「Package Update Server for WooCommerce」のクライアントライブラリ「NPUSWC Client」の使い方に関してです。

WordPressテーマとプラグインで使うためのライブラリは問題ないと思われますが、その他の用途でのライブラリはまだ準備中です。

販売するパッケージにインクルードして初期化するだけですから、合わせると楽に更新通知を届けることができるようになります。

 

「NPUSWC Client」の機能

まずは「NPUSWC Client」を使うことによりできることの紹介です。

現バージョンにおいて、大きく分けると3つの機能を有しておりますので、使用前にご確認ください。

 

「ダッシュボード」にサブページを作成

トークンを保存するページが追加されますので、WordPressテーマかプラグインの商品の購入者には、購入した際に取得可能となるトークンをそこで保存するようにご案内いただくことが推奨されます。

 

更新通知を管理画面にお届け

定期的に販売元のサイトに購入したトークンを使って、最新版の商品情報を取得し、使用しているものよりも新しいバージョンが販売されている場合、管理画面に通知が届くようになっております。

新しいバージョンがリリースされていると、「ダッシュボード」->「更新」のページなどでご確認いただけます。

 

他のテーマやプラグイン同様に更新

更新通知により新しいバージョンが確認されている場合、管理画面よりWordPressテーマやプラグイン同様に更新を行うことが可能です。

 

 

WordPressのテーマとプラグインの場合

テーマもしくはプラグインの任意の位置で、ダウンロードしたZIPファイルを展開してください。

「npuswc-client」というフォルダが出てくる筈です。

以下の手順で販売するテーマ或いはプラグイン内に書き込んでください。

  1. メインのクラスファイル「class-npuswc-client-loader.php」をインクルード
  2. クラス「NPUSWC_Client_Loader」の静的メソッド「load」をコール

コード例:

/**
 * Package Update Server Client
 * 
 * @param string $file
 * @param string $textdomain
 * @param string $plugin_dir_name
 * @param string $api_url_base
 */
if ( ! class_exists( 'NPUSWC_Client_Loader' ) ) {
  require_once( 'path/to/npuswc-client/class-npuswc-client-loader.php' );
}
$npuswc_client = NPUSWC_Client_Loader::load(
  MAIN_FILE, // like "path/to/functions.php" of the theme or "path/to/plugin-file.php" of the plugin
  TEXTDOMAIN, // Textdomain of your theme or of your plugin
  PACKAGE_DIR_NAME, // Folder name of the package
  WC_SITE_URL // URL of WooCommerce site which is installed Package Update Server for WooCommerce
);

 

メソッド「load」のパラメータについてですが、

  1. テーマなら「funcitons.php」の絶対パス、プラグインならメインのプラグインファイルの絶対パス
  2. テキストドメイン
  3. テーマやプラグインのフォルダ名
  4. 販売しようと思っているWooCommerceサイトのURL

の4つを入力するだけです。

あとは自動で管理画面にページが用意され、購入した際に生成されるトークンを保存することができるようになります。

 

 

更新通知用のプラグイン作成について

少し応用的な使い方ですが、販売するプラグインとは別に、更新通知用のプラグインを用意することができます。

メリットとして、プラグインが更新や特定の環境にて何かしらの不具合をもたらしてしまった場合、ユーザーが次の更新を待つために有効化し続ける必要がなくなることです。

予め「NPUSWC Client」をインクルードした更新通知用のプラグインを配信しておけば、トークンが有効である限り、プラグインを有効化していなくても更新情報を届けて、テーマやプラグインを更新することが出来ます。

 

 

 

 

 

 

 

 

ツールバーへスキップ