空のプラグインを自作する方法について説明する記事になります。
WordPressの初心者の方、特に初めてプラグインを開発する方にも分かるように、極力具体例を入れながら説明していきます。
空のプラグインを自作するまでの流れ
本記事は次の流れで解説しています。
- WordPress初心者がプラグインを自作するメリット
- WordPressのプラグインって作れるの?
- 空のプラグインの作成手順
- 手順1:自作プラグインのフォルダをサーバ上に作成する
- 手順2:自作プラグインのphpファイルをサーバ上に作成する
- 自作したプラグインをWordPressから確認
WordPress初心者がプラグインを自作するメリット
一般的には、プラグインを自作することでWordPressに色々な機能を追加可能ですが、これはあくまでphpやWordPress固有の関数を使いこなせばという話だと思います。なのでこちらは今回は説明しません。
便利な使い方を一つ紹介すると、function.phpの代わりに、自作プラグインからphpやWordPress関数を呼び出す(基本コピペ)ことです。
WordPressテーマのフォルダの中に入っているfuntion.phpではなく、プラグインから呼び出すようにすることで、WordPressのテーマに依存しないWordPress構築が可能になります。
テーマを今後変えるかもしれない、、と不安になりながらfunction.phpを編集する必要がなくなります。
あまりWordPressのテーマに依存しすぎずに、環境を構築していけると、WordPressの安定した管理に繋がるのではないか?を僕は考えていたりします。
WordPressのプラグインって作れるの?
複雑なものでなければ、意外と簡単に作ることができます。
ちなみに僕の例を紹介しますと、僕は普段、MATLABやPythonを仕事で使っており、HTML, CSS, JavaScript, php辺りは趣味程度でかじった程度です。
それでもこのブログを立ち上げるためにどうしても使いたかったソースコードを綺麗に表示するJavaScriptのライブラリ(Prism.js)を取り込むプラグインを作ることができました。(この辺りもまた別の記事で紹介していけたらと思っています。)
では早速空のプラグインを作成する手順を紹介していこうと思います。
空のプラグインを自作する手順
空のプラグインを自作する手順はこれだけです。
- 自作プラグインのフォルダをサーバ上に作成する
- 自作プラグインのphpファイルをサーバ上に作成する
手順1:自作するプラグインのフォルダをサーバ上に作成する
1−1:ワードプレスのフォルダ構成
まずワードプレスのフォルダ構成の中で、どこにプラグインがあるのかを見ていきましょう。
wp-contents/pluginsの中に、プラグイン名のついたフォルダが沢山入っていることが確認できました。
画像はpluginsフォルダまでしか見えておりませんが、この階層(pluginsフォルダの中)に適切なファイルを保存すれば、ワードプレスから読み出して貰えそうですね。
1−2:自作するプラグインのフォルダを作成する
早速、pluginsフォルダ内に、今回作成するプラグイン用のフォルダを新しく作成していきます。
この際、 フォルダの名前は他のフォルダと被らなければ好きな名前で作成して問題なさそうです。
ちなみに、WordPressで認識されるプラグイン名は、次で紹介するphpファイルに記述することになります。
このため、このフォルダ名は後から見直した際に分かる名前になっていれば問題なさそうです。
今回は、gloheyというプラグインを作成するため、同じ名前でgloheyというフォルダ名で作成しました。
基本的には自作したいプラグイン名前にしておけば問題ないと思います。
手順2:自作プラグインのPHPファイルをサーバ上に作成する
2−1:自作プラグインのPHPファイルの作成
次に、先程作成したフォルダの中に、.phpのファイルを作成します。
この際のファイル名も先程と同様、好きな名前で問題ないと思われます。
今回は、フォルダと同じ名前(glohey.php)で作成しました。
この時点では、ファイルの中身は空っぽで問題ありません。
2−2:自作プラグインのPHPファイルの中身の記述
次にPHPファイルに必要な情報を記載していきます。早速、どのように記載するかを見ていきましょう。
プラグインとして認識してもらうためには、PHPファイルにこのファイルがプラグインですよと最低限示すための記述が必要になります。
結論から示すと、「下のスクリプトコピーし、Plugin Nameを好みの名前に変更する」のみでOKです。
念の為、WordPress Codexのプラグインの作成ページでは次のように説明されています。
プラグインの主たる PHP ファイルの先頭には、標準プラグイン情報ヘッダーを含まなければなりません。このヘッダーは、WordPress にプラグインの存在を認識させ、プラグイン管理画面に表示させます。これにより、プラグインを有効化して、読み込んで、機能を走らせることができます。
標準プラグイン情報であるヘッダーは次になります。
<?php
/*
Plugin Name: (プラグインの名前)
Plugin URI: (プラグインの説明と更新を示すページの URI)
Description: (プラグインの短い説明)
Version: (プラグインのバージョン番号。例: 1.0)
Author: (プラグイン作者の名前)
Author URI: (プラグイン作者の URI)
License: (ライセンス名の「スラッグ」 例: GPL2)
*/
?>
少なくともPlugin Name の行さえあれば、WordPress がプラグインを認識するようです。
また、各行の順番が異なっても問題なく読み込まれるとのことです。
自作したプラグインをWordPressから確認
早速、WordPressを立ち上げ、プラグインの設定画面から、先程作成したプラグインが認識されているかを確認します。
Classic Editorに並んで、gloheyというプラグインがきちんと認識されました。
後は、他のプラグイン同様、有効化を押して、動作させる形ですね。
もちろん現段階では、プラグインのヘッダーしか記述していないため、有効化しても何も動作しない状態ではありますが。
今回は一旦ここで、「空のプラグインを自作する」は完成にしたいと思います。
途中で紹介した自作プラグインのメリットである、function.phpの代替として使う方法は、別の記事でまとめられたらと考えています。
それにしても、偉大なプラグインが沢山ある中で、自分で作成したプラグインが、WordPressから同じ様に扱って貰えているところを見ると少し嬉しくなりますね。
気になったという方、自作プラグインを作成する第一歩としてこの記事を参考にして頂ければ幸いです。