簡単!WordPressプラグイン実装

 wordpressのプラグインの実行の仕組みはシンプルです。

  • 実行したいコードをphpの関数として実装する
  • wordpress側に呼び出してもらう

だけです。

plugin2_03


プラグインの1例

 まずは1例として、画面のフッター領域に「Hello Dummy」と表示するだけのシンプルなプラグイン dummy.php を作成しましたのでご覧ください。

実装内容

dummy.phpの実装内容

コーディングの内容は

  • 9~10行目で「Hello Dummy」と画面出力するコードを関数print_dummy()として実装
  • 14行目でプラグインAIP add_action()を使ってfooter領域の描画タイミングで実装した関数print_dummy()を呼び出してもらうように登録

※ファイルのコメント部分にもプラグイン登録の為の意味があります。プラグイン登録については超簡単!WrodPressプラグイン登録をご参照ください。

ファイルの配置

 このソースファイル dummy.php をサーバー上のプラグインフォルダに配置します

wordpressのインストールフォルダ/
wp-content/
plugins/
dummy.php

実行画面

 プラグインを有効化して、サイトの表示をすると以下のように画面の左下に「Hello Dummy!」の文字が表示されます。

plugin2_02

処理の流れ

 まずユーザーがサイトを訪れるとWordpressに含まれるindex.phpが起動します。 そこから、内部モジュールやテーマなどと一緒に、プラグインも読み込まれてプラグインファイルのコードが実行されます。

このサンプルではadd_action()を使ってprint_dummy()を登録する処理が実行されます。(print_dummy()は関数定義なので、print_dummy()そのものはこのタイミングでは実行されません。)

その後、footerを描画するタイミングになるとprint_dumy()呼ばれて実行されます。

関連図

この時の内部の処理の流れは以下のようになっています。
plugin2_01

プラグインAPIについて

 サンプルではプラグインAIP add_action()を使って、footer領域の描画タイミングで、実装した関数が呼び出されるように登録ましたが、それ以外にプラグイン呼び出しの為のパラメータやAPIが色々用意されています。

また、テンプレートからphpのコードとして呼び出してもらう為に、単に関数だけ定義するテンプレートタグと言う実装もあります。

関連するWordPress Codex 日本語版のページを載せておきますので、ご参考までに。
プラグインの作成
プラグイン API
テンプレートタグ


まとめ

 簡単なプラグインのサンプルで、実行の流れを紹介させて頂きました。複雑なプラグインを作るとしても、基本的には関数を実装して、呼び出してもらうという流れは同じになるはずです。
また、APIやパラメータなどはいきなり全て覚えるのではなく、必要な時に必要な情報だけを調べて使いながら覚えていくのが効率的だと思います。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です