いろいろな方が公開されているプラグインを使っていると、自分でも作りたくなってきます。
また、プラグインをカスタマイズしようとする時にも最低限の知識がないとソースを理解するのが苦しいので、ちょっと勉強がてらプラグインの作成方法をブログに書いてみることにします。
準備
- 開発用エディタ
簡単なプラグインの作成ならテキストエディタで十分です。 - 開発用フォルダ
当初、WordPressのwp-content/pulginsフォルダとは別に用意しましたが、動作確認する時にコピーするのが面倒なので直接wp-content/pulginsフォルダ内に置きました。 - 空のphpファイル
ファイル名はhello-world.phpとしました。
仕様
- ブログの先頭に「Hello World」と表示する
コーディング
ソースコード全体
<?php
/*
Plugin Name: Hello World
Plugin URI: https://it-life.kakinota.net/(plugin-page)
Description: Hello Worldと表示するプラグイン
Version: 1.0
Author: kakinota
Author URI: https://it-life.kakinota.net/
License: GPL2
*/
function helloworld(){
print('Hello World');
}
?>
ソースコードの説明
ファイルのヘッダー部分にプラグインに関する情報（標準プラグイン情報）を記述し、その後にテンプレートタグ関数を記述しています。
標準プラグイン情報の記述
WordPressに作成したプラグインを認識させるためにはphpファイルのヘッダーに標準プラグイン情報を以下のような書式で記述する必要があります。
<?php /* Plugin Name: (プラグインの名前) Plugin URI: (プラグインの説明と更新を示すページの URI) Description: (プラグインの短い説明) Version: (プラグインのバージョン番号。例: 1.0) Author: (プラグイン作者の名前) Author URI: (プラグイン作者の URI) License: (ライセンス名の「スラッグ」 例: GPL2) */ ?>
これによりプラグイン管理画面に表示させたり、プラグインを有効化できるようになります。必須なのはPlugin
Nameだけなので、すべて記述する必要はありません。詳しくは以下のページをご覧下さい。
プラグインの作成 – WordPress Codex 日本語版
テンプレートタグ関数の作成
テーマに直接タグを埋め込むことにより、その位置に’Hello World'と出力するhelloworld()という関数を作成しました。普通に関数を定義してprint()するだけの単純なものなのであっという間に完成しました。
使い方
テンプレートタグの埋め込み
使用中のテーマにあるheader.phpへ以下のコードを<body>タグの下に埋め込みます。先ほど作成した関数を普通に呼び出すだけです。
<?php helloworld(); ?>
プラグインの有効化
すでにwp-content/pulginsフォルダ内にファイルがあるので、WP管理画面から[プラグイン]へアクセスするとプラグイン一覧の中に作成したものが登録されていることが確認できます。
自分の作成したプラグインが登録されるとちょっと嬉しい(^o^)
結果画面
有効化後ブログにアクセスすると上の図のように「Hello World」と表示されます。
今回はテンプレートタグ関数を使ったやり方を勉強しましたが、次回はフックを使ってHello Worldを作ってみたいと思います。