[WordPress プラグイン 開発]➁プラグインの雛形をつくる。

WordPress

今回は、WordPress のプラグインを作るときはお約束になっていて、必ずやらなければならないことをできるだけ簡単にする方法です。

さっそく、やってみましょう。

プラグインの雛形をつくる

最低限必要な雛形のファイルが以下になります。

plugin_name.php -> プラグインの名前のついたPHPファイルです。

License.txt -> GPLv2ライセンスで作成する場合には必要(フリーで配布する場合など)

ライセンスに関しては、基本的にWordPress本体と同じGPLv2ライセンスにするのが主流なようです。

このあたりは有料・無料でどうするのか分かれますが・・・。

Envatoなどで販売している有料版でも結局はインストールしてしまえばソースコード丸見えなわけで・・・まあパクリ放題ですよね(笑)。

ライセンスはplugin_name.phpファイルに書いてもいいのですが、コードの可読性が悪くなるので別ファイルがオススメな様です。

*ちなみにGPLv2ライセンスとは、改変したり・再配布してもOKだけど自己責任でね、みたいな意味です(かなりざっくりなので、詳しくはググってください・・・すいません。)

WordPressのプラグインを作るときのお約束。

「plugin_name.php」の先頭部分に書くお約束があります。

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

WordPress Codex日本語版が参考になりますが、とにかく見にくいのでなれるまでたいへんです。

わかりやすく解説しているサイトを探した方が良いかもです。

最終的に参考にするようにしましょう。

面倒な部分は楽をしよう

で、毎回書くのは面倒なのでそれを楽をします、それが以下です。

WordPress Plugin Boilerplate

囲っているところを入力して「Build Plugin」をクリックすると、雛形となるファイルが出来上がります。

ちなみに、英語またはローマ字が無難です(配布が日本語圏だけなら日本語でもOK)

今回は以下のようにしてみました。

簡単に、雛形のファイルが出来上がりました。

そしてWordPressにプラグインをインストールします。

直接プラグインフォルダに放り込むときはzipファイルを解凍してフォルダを放り込んでください。

上の図のマークをクリックするとWordPressのインストール先のフォルダが開くのでpluinsフォルダに放り込めます。

通常はzipファイルのまま、WordPress -> ダッシュボード -> プラグイン -> 新規追加 になります。

うまく行けばプラグインに表示されます↓。

これで管理画面でプラグインが有効にできます

これを見るとWordPress Plugin Boilerplateのサイトで入力した項目がどこになるのかわかると思います。

Visual Studio Codeで開くと以下のフォルダ構成になってます。

  • admin -> 管理画面で使う処理を書く、ようするに内部の処理コード。
  • includes -> 共通してつかうクラス等を定義する部分です。
  • languages -> プラグインを多言語化するファイル、日本語圏だけなら気にする必要はないです。
  • public -> サイト側に表示したりする処理を書く、サイトを訪問するユーザー向けの処理コード。
  • index.php -> 基本的に放置で良いです、正確にはどうかもですが触ることはほぼないと思います。
  • LICENSE.txt -> GPLv2ライセンスが書いてあります。
  • owt_boiler.php -> プラグインのルートファイル、ここからコードがスタートします。
  • README.txt -> まあなんだか色々書いてあります、暇なとき読んでみてください。
  • uninstall.php -> プラグインをアンインストールしたときの処理、データベースの削除とか。

ざっくりこんなところですが、開発を進めながら細かい部分は理解していくこととしますね。

まとめ

WordPress Plugin Boilerplateを使うと簡単にプラグインの雛形が作れます。

これでも個人的には面倒な作業です、WordPress Plugin Boilerplateを使わないとさらに手間がかかることになりますので、作者の方に感謝です。

今回は以上です。

ありがとうございました。

次回こそはコードを書きたいです・・・予定。

ではまた次回。

タイトルとURLをコピーしました