前回はテーマのfunctions.phpに、ショートコードに文字列を出力するコードを書きました。
しかし、これではテーマを変更してしまうと、functions.phpが変更されてしまい、追加したコードが実行されなくなってしまいます。また、functions.phpにコードを書いてしまうと、プラグインとして配布できなくなります。
今回は、プラグインとして新しいファイルを作成し、そのファイルにコードを書いていくようにします。また、管理ページのプラグイン一覧に、作成したプラグインが表示されるようにします。
プラグインの命名
プラグインのファイルを作成する前に、プラグインの名前を考えます。ここで言う名前は呼称のことでなく、WordPressが認識する名前です。使えるのは英字、数字、空白と一部の記号です。名前が他のプラグインとかぶらないよう、ユニークにする必要があります。
ここでは、fow-online-help と名付けます。
ファイルの作成
WordPressのプラグインフォルダー内に、専用のフォルダーを作成します。フォルダー名はプラグインと同じ名前、fow-online-help にします。プラグインフォルダーは、通常、以下の場所にあります。
/wp-content/plugins
このpluginsフォルダーの下に、自分のプラグインのフォルダーを作成します。
fow-online-helpフォルダーを作成したら、そのフォルダー内にPHPファイルを作成します。ファイル名の決まりは特にありません。ここでは「onlinehelp_main.php」とします。
プラグインヘッダーの記述
onlinehelp_main.phpファイルがプラグインと認識させるには、プラグインヘッダーを記述する必要があります。プラグインヘッダーとは、指定の書式にしたがって記述するコメント行です。
ファイルの先頭に<?phpと記述し、その次の行から以下のコメントを入力します。
/*
Plugin Name: (必須、プラグインの名前)
Plugin URI: (プラグインの説明と更新を示すページの URI)
Description: (プラグインの短い説明)
Version: (プラグインのバージョン番号。例: 1.0)
Author: (プラグイン作者の名前)
Author URI: (プラグイン作者の URI)
License: (ライセンス名の「スラッグ」 例: GPL2)
*/各行の () 部分を、自分のプラグインに合わせて変更します。Plugin Nameだけは必須項目です。あとの行は空白にするか、削除してもかまいません。情報は英文で記入するのが推奨されていますが、日本語圏だけで使用するなら日本語でかまいません。今回は以下のように、Plugin NameとVersionだけを記入し、あとは空白にしておきます。
<?php
/*
Plugin Name: オンラインヘルプシステム
Plugin URI:
Description:
Version: 1.0
Author:
Author URI:
License:
*/ここまでできたら、いったん保存します。文字のエンコードはUTF-8、改行は LF にします。エンコードをUTF-8以外にすると文字化けします。また、改行コードを CRLF にすると、WordPressでは動作しないおそれがあります。
コードの移動
前回functions.phpに記述したコードを、onlinehelp_main.phpに移動します。onlinehelp_main.phpファイルの内容は、以下のようになります。
<?php
/*
Plugin Name: オンラインヘルプシステム
Plugin URI:
Description:
Version: 1.0
Author:
Author URI:
License:
*/
/**
* オンラインヘルプの出力
*/
function print_online_help_system()
{
return 'ここにオンラインヘルプを表示する';
}
add_shortcode('fow_online_help', 'print_online_help_system');動作確認
まずは前回ショートコードを記入した記事を開き、表示を確認します。以下のように、ショートコードがそのまま表示されてしまいます。
これは、今作成したプラグインを有効にしていないためです。
プラグインの一覧ページに移動してください。一覧の中に、オンラインヘルプシステムが表示されているはずです。もし表示されていなかったら、プラグインヘッダーの記述に誤りがあると考えられます。
オンラインヘルプシステムの「有効化」をクリックして、プラグインを有効にします。再度、記事に戻り、表示を確認してください。以下の画像のように、ショートタグが変換されているはずです。
