はぴすぷ

【WordPressプラグイン】え?超簡単じゃん!プラグイン開発は実は難しくなかった!

      2015/11/26

WordPressのカスタマイズを行なっていて、いつか自分もテーマとかプラグインを作ってみたいなーと思っていました。

ただ、デザインセンスがなさすぎるので、テーマの作成は出来るようになっても、たぶん公開できるようなものは作れないですねw

じゃあプラグインなら…。と思ってプラグインの開発について調べてみると、そんなに難しくなさそう。

調べれば調べる程、思ってたのと違う…!超簡単じゃん!

結構規模の大きいプラグインの中しか見たことが無かったので、勝手にビビってただけでしたw

実際には全く難しくなかったので、プラグインの開発について紹介したいと思います!

スポンサーリンク

プラグインの作成方法

プラグイン置き場である「wp-content\plugins」に以下のコメントを書いた、phpファイルを作成します。
(ファイル名やプラグインの名前は、他のプラグインと被らなければ何でも良いです。)

<?php
// Plugin Name: My Test

完成!( ・`ω・´)

これで管理画面に自作のプラグインが表示されます!

wp_plugin

そうなんです。たったこれだけなんです!

ちなみに、自作プラグインのディレクトリ作成は任意で、ディレクトリを作成する場合、プラグイン用に作成したphpファイルと同じ名前でなくても問題ありません。でも名前が違っていると分かりにくいので、揃えることをオススメします。

プラグインの情報を設定する

とりあえず、コメントでプラグインの名前(Plugin Name)だけ書けば作成できることは分かりました。

ただ、あまりにもシンプル過ぎるので、プラグインの情報を設定する項目を紹介します。

  • Plugin Name: プラグインの名前(必須
  • Plugin URI: プラグインのホームページのURI(ユニークにする必要あり)
  • Description: プラグインの説明
  • Version: プラグインのバージョン
  • Author: プラグインの著者名
  • Author URI: プラグイン著者のホームページのURI
  • License: 適用するライセンスのスラッグ
  • License URI: ライセンスのホームページのURI
  • Text Domain: プラグインのテキストドメイン(翻訳を適用する時に使用する一意の識別子)
  • Domain Path: ドメインパス(翻訳ファイルが配置されている場所)

全て書いておく必要はないですが、緑で塗った「説明」「バージョン」「著者名」くらいは入力しておきましょう。

サンプルとしてはこんな感じ。

<?php
/*
Plugin Name: My Test
Plugin URI:  http://hapisupu.com/2015/11/wordpress-plugin-create-01/
Description: これはテスト用のプラグインです。
Version:     1.0
Author:      松田 康弘
Author URI:  http://hapisupu.com
License:     GPL2
License URI: https://www.gnu.org/licenses/gpl-2.0.html
*/

世界中の人に使って欲しければ全て英語で書くべきですが、日本人をメインターゲットにしてたり、自分用のものであれば日本語で問題ありません。

先ほどの設定で、こんな感じに表示されます。

SS_4692

それっぽくなりました(^q^)何もしてくれてませんがw

ライセンスについて

ライセンスって難しいですよね。基本的に英語だし、日本語だとしても固い言葉で何いってるのか分からない(;´Д`)

とは言え、違反して怒られると困るので、ちゃんと書いておきます。

WordPressのライセンスはGPL2(GNU General Public License v2)である為、プラグインのライセンスはこれに準拠する必要があります。

一応、GPL2がどういうものかは、翻訳されているので詳しくはこちらを確認して下さい。
GNU一般公衆ライセンス v2.0 – GNUプロジェクト – フリーソフトウェアファウンデーション

とりあえずは、GPL2かそれ以降にしておけば問題ありません。このライセンスを適用するにはどうするかというと、以下の文をプログラムに含めればOKです。

Copyright (C) yyyy name of author

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

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 Street, Fifth Floor, Boston, MA  02110-1301, USA.

1番上の行は以下の様に変更します。問い合わせが出来るようにメールアドレスも足した方が良いそうです。

Copyright (C) 2015 Yasuhiro Matsuda (hapisupu@gmail.com)

メインのphpファイルのプラグインの設定の後にコメントとして追記するか、プラグインのディレクトリに「license.txt」等のファイルを作成して、そこに記載します。

色んなプラグインを参考にしてみると、ライセンスのファイルを別途作成している場合は、ライセンス全文を載せているものが多いです。

推奨は全ファイルの冒頭に記述することらしいですが、邪魔になるので私はライセンスファイルを置いておく方法をマネしました。

これで、他の人に配布しても問題ないようになりました!

プラグインの中身の実装

実は、簡単なものであれば、プラグインだからと言って特別なことをする必要はありません。

テーマの中の「function.php」にゴリゴリ書いていた内容を、プラグインのファイルに移せばいいだけなんです。

なので、過去に紹介したこれらのカスタマイズの内容などは、全てプラグイン化出来るわけです。

そのままだと内容的に寂しいので、柔軟に設定出来るように育てれば需要が出てくるかもしれません。

そして管理画面に設定画面を追加出来れば、かなりプラグインって感じになりますよね!

設定画面の作成方法については、少し長くなるので次回に回します。

終わりに

プラグインの作成って聞くと、すごくハードルが高そうに感じてしまいますよね。

でもちょっとしたプラグインなら、凄く簡単に作れることが分かったと思います!

いきなり大層なものを作り始めると挫折しかねないので、まずは簡単なものから徐々にステップアップしていきましょう!

次回は、管理画面に設定画面を用意して、プラグインの設定値を更新できるようにするまでを紹介する予定です。

それでは!

2015/11/26追記:書きました!
【WordPressプラグイン開発】管理画面にメニュー・サブメニューを追加する方法

 - WordPress, プラグイン