「初心者でもプラグイン開発はできる?」
「どんな手順で開発するの?」
「WordPressで公開する方法は?」
などの疑問をお持ちではありませんか?
WordPressをより便利に利用するためのプラグインを作履帯と考えていても、初心者のうちは何から手をつければいいのか分かりませんよね。
そこでこの記事では、プログラミング初心者がプラグインを作る手順を1からお伝えします。
- 開発前に知っておきたいこと
- WordPressで公開する手順
- プラグインの公開後にやること
などについて解説するので、プラグイン開発に興味がある方はぜひご覧ください!
監修者:平井 隆嗣
システム開発に加えてマーケティングまで対応し、集客や売上に貢献するエンジニア。
開発会社にて4年間の勤務をし、リーダーとして活躍したあとフリーランスとして独立。WordPress導入、デザイン、開発、アプリケーション開発などを幅広く手掛ける。
監修者:迫 佑樹
株式会社SkillHacks代表取締役。大学在学中からプログラミングスキルを身につけ、フリーランスエンジニアとして独立。
自身の経験を活かしプログラミングを教え、その知見からオンラインスクール事業Skill Hacksを運営。そのほか、実店舗ビジネスや知識プラットフォームBrainなどさまざまなビジネス経営中。
初心者がWordPressのプラグインを開発する前に覚えておきたいこと
初心者がWordPressのプラグイン開発にチャレンジする前に、最低限知っておくべきことを4つ紹介します。
- PHPの基礎知識
- 名前の付け方
- 「フックする」という概念
- デバッグモードの使い方
開発本番で役立ちますので、確認しておきましょう。
1.PHPの基礎知識
プラグインはPHPという言語によって開発されるので、まずは基礎知識が必要です。
- 開発環境の整え方
- 基本的なプログラミング
- アプリケーションの作り方
などを確認しておきましょう。
PHPは、プログラミング学習サイトやオンライン講座で習得可能です。
まずは基礎知識を理解して、自分でプログラミングが作成できるようになることを目指しましょう!
2.名前の付け方
PHPで使う関数名の付け方を確認することも重要です。
同じ名前の関数が存在すると、影響しあって本来の働きができなくなってしまいます。
例えば「hello()」のようなシンプルな関数名は、他のプラグインの関数と被る恐れがあるので注意しましょう。
関数名が被らないように対策する方法は主に2つです。
- 「特定のクラス内でのみ有効」とする
- プレフィックスを付ける
プレフィックスとは、名前の頭に特定の文字を付け加えてオリジナリティを出す工夫のこと。
例えば全ての関数の頭に「skillhacks◯◯」と統一して文字をつけるようなイメージです。
「japan」など普遍的すぎる語句でなくオリジナルの言葉を使えば、関数名が被ることはほぼないでしょう。
3.「フックする」という概念
WordPressでは「アクションフック」が処理のトリガーとなります。
WordPressが何か処理を行う際に「この処理も一緒にやって!」と紐付けることを「フックする」と表現します。
アクションが起きるきっかけとなるポイントに、付随して実行される処理を登録するのが「add_action」の関数です。
「add_action」の使い方として、以下のようなポイントを確認しておきましょう。
- パラメータの使い方
- アクションフックの例
- 関数を定義する方法
フックの概念を理解することで、より魅力的なプラグインの作成につながります。
4.デバッグモードの使い方
デバッグモードは、PHPの関数にエラーがあれば表示し、簡単に修正できるようにするモードのこと。
デバッグモードを有効にするには、WordPressの「wp-config.php」から以下の記述を探します。
/**
* 開発者へ: WordPress デバッグモード
*
* この値を true にすると、開発中に注意 (notice) を表示します。
* テーマおよびプラグインの開発者には、その開発環境においてこの WP_DEBUG を使用することを強く推奨します。
*/
define(‘WP_DEBUG’, false);
「define(‘WP_DEBUG’, false);」を「define(‘WP_DEBUG’, true);」に編集するだけで、デバッグモードへの切り替えは完了です。
記述ミスを防ぐためにも、プラグインを開発するときはWordPressのデバッグモードを活用しましょう。
WordPressプラグインを開発する手順
プラグインを開発する手順は以下の5ステップです。
- プラグインのタイトルを決める
- PHPファイルを作る
- プラグイン情報を書く
- ライセンスを書く
- 説明書を作る
それぞれのポイントを確認しておきましょう。
1.プラグインのタイトルを決める
まずはプラグインのタイトルを決めます。
プラグインの名前に入れられるのは次の3つです。
- アルファベット
- 数字
- 空白
- ハイフン・アンダースコア
日本語は使えないので注意しましょう。
また、プラグインと重複しない唯一の名前をつけてください。
他のプラグインとファイル名や関数が重複するのを避けるためです。
名前を正式決定する前に、同じプラグイン名が存在しないか検索してみることをおすすめします。
2.PHPファイルを作る
次にPHPファイルを作ります。
プラグインタイトルと同じように、他と重複しないオリジナルのファイル名をつけましょう。
PHPで使う拡張子は「.php」です。
メモ帳などでファイルを作って「.txt」などになっている場合は、ファイル名を変更してください。
3.プラグイン情報を書く
メインファイルの先頭には「標準プラグイン情報ヘッダー」を書く必要があります。
プラグインをWordPressに読み込ませてプラグインの一覧に表示させたり、認識して機能を実行させたりするためです。
書式の例は以下の通りです。URLではなくURIを記載することに注意しましょう。
<?php
/*
Plugin Name: プラグインのタイトル
Plugin URI: プラグインの説明と更新を示すページのURI
Description: プラグインの簡単な説明
Version: バージョン情報(1.0.0など)
Author: 製作者名
Author URI: 製作者のURI
License: ライセンス名
*/
?>
4.ライセンスを書く
ライセンスとは「使用許諾」のことで「このような条件でプラグインが使えます」とユーザーにわかりやすく伝える手段となります。
WordPressのプラグインハンドブックで推奨されているライセンスの例文は以下の内容です。
/*
{Plugin Name} 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
any later version.{Plugin Name} 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 {Plugin Name}. If not, see {URI to Plugin License}.
*/(引用:WordPress.org「プラグインハンドブック」)
5.説明書を作る
開発したプラグインをWordPressの公式ディレクトリで配信する場合は、決められた様式に従ってreadmeファイル(説明書)を作ります。
「readme.txt」のファイルを作成し、必要事項を記入しましょう。
主な内容は以下の通りです。
- プラグインの基本情報(製作者やライセンスなど)
- 説明
- FAQ(よくある質問)
- スクリーンショット
- 更新やバージョンに関する情報
コピペして使えるテンプレートはWordPress.orgで配布されています。
開発したプラグインをWordPressで公開する手順
開発したプラグインはWordPress.orgを介して全世界に向けて配信できます。
公開までに必要な手順は以下の通りです。
- アカウントを登録する
- 圧縮ファイルをアップロードする
- 確認メールに対応する
- 公開作業を行う
プラグインを使ってもらいたいと考えている方は、ぜひ配信してみましょう。
1.アカウントを登録する
まずは配信先であるWordPress.orgでアカウント登録を行います。
メールアドレスやユーザー名を入力するだけで簡単に登録できます。
2.圧縮ファイルをアップロードする
開発したプラグインのファイルをzip形式で圧縮します。
ファイルの圧縮は特別なソフトを使わなくても、WindowsやMacの標準機能で問題ありません。
WordPress.orgの「プラグインを追加」から圧縮済みのファイルをアップロードし、プラグインの公開申請を行いましょう。
なお、サイトにログインした状態でないとアップロード用メニューは表示されません。
3.確認メールに対応する
アップロードを行って公開申請をすると、WordPress.orgから確認メールが届きます。
プラグインの必要性などを質問される場合があるので、可能な限り答えておきましょう。
なお、WordPress.orgとのメールのやり取りは全て英語です。
4.公開作業を行う
公開申請が承認されるとメールでSVNリポジトリのアドレスが届きます。
以下の手順で公開申請を行いましょう。
- Subversionをインストールする
- Subversionのディレクトリを作る
- リポジトリをチェックアウトする
- チェックアウトしたディレクトリにファイルを格納する
- コミットする
無事に公開ができればプラグインの検索画面で情報が表示されるようになります。
プラグインの公開後にやること
プラグインを公開した後は、ユーザーに長く親しまれるよう以下のことに取り組んでいきましょう。
- メンテナンス
- 宣伝
- 国際化の検討
プラグインは公開して終わりではありません。それぞれ確認しておきましょう。
1.メンテナンス
公開後のプラグインはメンテナンスしなければ上手く動作しなくなる可能性があります。
WordPressや他のプラグインのアップデートの影響を受ける恐れがあるからです。
大型のアップデートがあれば動作を確認し、必要に応じてメンテナンスを行いましょう。
ユーザーからの不具合報告やリクエストに合わせてメンテナンスするのもおすすめです。
定期的に最新版が公開されているプラグインのほうが、ユーザーから好印象を持たれるでしょう。
2.宣伝
プラグインを宣伝して、ユーザーに存在を知らせましょう。
ただ公開しただけではよほどのきっかけがないと人に知られないからです。
LPページを作ったり、SNSやブログで宣伝したりすると効果的ですよ。
3.国際化の検討
プラグインは、内容によっては海外からも使ってもらえます。
海外からのインストールも視野に入れている場合は、プラグインの国際化を行いましょう。
他言語に対応するためにローカライズを行います。
ローカライズとは表示される文章を翻訳する処理のこと。
Poeditなどのツールを使うと簡単に変換できます。
世界中から親しまれるプラグインを目指してアップデートしていきましょう。
PHP Hacksなら最速でPHPエンジニアを目指せる
- 初心者からPHPの知識を学べる
- 無期限の質問サポート付き
- 買い切り型で受講期限も無制限