そんなにGeekじゃないエンジニアブログ

WordPressプラグイン開発でバージョンを上げて自動更新を有効にする方法

calendar

こんにちは。でんすけ(@notgeek_densuke)です。

WordPressのプラグインを開発、公開した後、
バグを治したり、新しい機能を追加したりして
更新をかけることがあるかと思います。

そんなときは、バージョンを上げる必要があるのですが、
どこを修正すればいいか忘れがちなので、メモ代わりに書きのこしておきます。

関連記事:

WordPressプラグイン開発!初心者からでも始められる、開発基礎知識編

[WordPressプラグイン開発]公式ディレクトリに公開してリリース!ホスティング申請の流れ

スポンサーリンク

WordPressプラグインバージョンアップ時に変更すべきファイル

もろもろ、機能追加、バグ修正をかけて、
さぁいまからSVNに上げるぞ!となったとき。

どのファイルを修正するべきかというと、
以下の3つです。

  • メインのphpファイル
  • readmeファイル
  • tagsディレクトリ配下

メインのphpファイル

まずは、プラグインのメイン処理を実行するphpファイル。
プラグインの情報をWordPressに認識してもらうため、
こんな感じのコメントを先頭に書いてあるかと思います。

<?php
/*
Plugin Name: (プラグインの名前)
Plugin URI: (プラグインの説明と更新を示すページの URI)
Description: (プラグインの短い説明)
Version: (プラグインのバージョン番号。例: 1.0)
Author: (プラグイン作者の名前)
Author URI: (プラグイン作者の URI)
License: GPL2

Copyright 作成年 プラグイン作者名 (email : プラグイン作者のメールアドレス)

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License, version 2, as
	published by the Free Software Foundation.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/
?>

この中のVersionの値を増やします。

元々が1.0だった場合は、1.1にするとか、2.0にするとか。

readmeファイル

readmeファイルで修正が必要なのは、このあたり。
必要な部分だけを抜き出します。

Stable tag: 1.1 

== Changelog ==

= 1.1 =
bug fix

= 1.0 =
release

ChangeLogは、何が変更されたかをユーザーに伝えるのに必要な情報です。

Stable tagは、元々記載していない人は更新は不要かもしれません。
tagsディレクトリ内のソースを読み込んでもらう場合に必要です。

その他、機能追加などで説明が必要になる場合は
適宜変更をしましょう。

tagsディレクトリ配下

readme.txtでStable tagを指定した場合、
そのtagと同名のディレクトリが必要となります。

「Stable tag: 1.1」と記載した場合、
tagsディレクトリ内に「1.1」という名前のディレクトリを作って、
その中に、trunkのソースをそのままコピーしておきます。

readmeのStable tagの指定は、
「tags内のバージョン1.1を使ってね!」という意味になります。

なので、trunk内で開発したソースたちを、
リリース時に「tags/1.1」内にコピーする必要があるのです。

ただし、Stable tagを記入していない場合は、「trunk」内のソースが利用されます。

どちらを使ってもいいのですが、運用上はtags内にバージョンディレクトリを作って管理するのが良いかと思います。

まとめ

ここまでできれば、あとはsvnにコミットするだけです。
プラグインの更新が反映されるまで、コミット後5分程度かかることがありますが
少し待っていれば、自動的にバージョンが更新され、インストールしているユーザーが「更新」できるようになります。

いくつか更新しなければいけないファイルがあるので、
忘れずに更新して、プラグインをどんどんバージョンアップしていきましょう。

それではまたー。

この記事をシェアする

コメント

コメントはありません。

down コメントを残す




CAPTCHA


このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください