WordPressでプラグインを作るお話

  • このエントリーをはてなブックマークに追加

WordPress(以下WP)はメジャーなCMSであり、様々なプラグインがあるのでそれを利用していろんなサイトを作ることができます。

ただ、どうしても既存のプラグインでは対応できない事もあり、そういう場合は独自でプラグインを作ってしまった方がよかったりしますね。

具体的にはフルスクラッチのCMSをWPに移植する場合などです。

今回は独自プラグインをどうやって作るのかをさわりの部分だけ説明します。

プラグインの機能

今回は以下の機能のプラグインを作ります。
  • 管理画面にメニューを追加し、そこで挨拶文を入力できる
  • 挨拶文はテーブルを新規で作成する
  • テーマからは挨拶文表示関数を呼び出すと表示される
この程度であればわざわざテーブルを作らなくてもwp_optionsに書き込めばいいですし、WPのマニュアルにもできるだけwp_optionsを使えとありますが、今回はあえて使います。

 

ファイル構成


フォルダ名とファイル名を共通にします。
またdefine.phpは定数とか設定するときはこっちにしておくと管理が楽です。

プラグインの情報を設定する

8bit-blog-plugin.phpの最初にコメントで下記のように記述します。

Plugin Name プラグイン名です。英数字と空白のみ使用可能です。
Description プラグインの説明文です
Version プラグインのバージョンです
Auther プラグインの作者名です。ここは会社名や個人名を入れましょう
Author URI 名前にURLを設定することができます

その他ライセンスを記述する必要がありますが、今回は自作プラグインかつ公開しないので、ライセンスは省きます。
(公開するならLICENSEを「GPL」に設定するのがいいと思いますが)

ちなみに上記の設定をした状態でWPの/plugin/フォルダにアップしてWP管理画面のプラグインを見ると


こんな感じで表示されます。

インストール時の初期設定を行う

このまま有効化を行っても意味がないので、初期設定および処理を入れます。

 

__construct関数の中に設定する値を入れてます。

これは今回テーブルを使用するのですがテーブルの構造変更や追加などを行う場合、このバージョンを変更することで
更新を行った際に自動的に行うようにするためです。
ただ今回は不要ですね。

これは使用するテーブル名です。
$this->wpdb->prefixをはじめにつけないとWPで設定したprefixがつかないので気をつけましょう。

これは管理画面左側のメニューを表示するための設定値です。

これはWPの関数で「 add_action( ‘admin_init’, array( $this, ‘create_tables’ ) );」は「管理画面にアクセスした時にcreate_tables関数を実行しなさい」と言うことです。

同様に「add_action( ‘admin_menu’, array( $this, ‘add_pages’ ) );」は「管理メニューを作る場合にadd_pages関数を実行しなさい」となります。

最後の「$BlogPlugin = new BlogPlugin;」ですが、このクラスを実行するためのものです。
これを置かないと処理されないので忘れずに。


 

実際に呼び出された「create_tables関数」の処理です。
毎回CREATE TABLEをするのは意味がないので、最初にdb_versionの比較を行い、値が異なる場合(初回など)に
テーブルの作成を行います。

ここでメニューを生成します。
「add_menu_page」でメインメニュー、「add_submenu_page」でその下のサブメニューを作ります。

メニューを押すと「show_plugin_list_page関数」サブメニューの「登録」を押すと「show_plugin_detail_page関数」が呼び出されるので、それぞれ文字を表示するようにしましょう。
ここにフォームや処理を入れることで管理画面の機能を追加します。

ここまで来た状態で先ほどのプラグイン画面から「有効化」を押してみましょう。


こんな感じでアイコンと「プラグインテスト」と言うメニューが表示されました。

データベースを見てみると、「wp_test_plugin_tbl」テーブルが自動的に作成されてますね。


これで設定完了です。
このあとは色々と処理を入れるのですが、それは割愛します。

テンプレートにプラグインを呼び出す

作成したプラグインをテンプレートから呼び出してみましょう。

 

これは単純に今の日時を表示するだけですが、使い方としてはここに表示したい情報を記述します。

これをテンプレート側で

で表示することで今の日時が表示されます。

最後に

今回はプラグインの基本的なベースしか説明していませんが、普通のwebアプリケーションのような事もできると思いますし、JSONで出力することもできるので
可能性が色々と広がると思います。

執筆者:松本[ エンジニア ]

関連記事

マークアップ

背景に画像や動画を置いてパララックス効果で見せる

サイトを作っているとスクロールした時に背景画像などを固定させておきたい、パララックス効果を使いたいという時があると思います。 簡単なものであれば簡単なcssで実現できます。 目次1 背景画像をパララックス効果で見せる1.1 DEMO1.2 HTML1.3 CSS 背景画像をパララックス効果で見せる DEMO See the Pen Untitled by kkdd (@kk8kk) on CodePen. なんとなくよく見る感じの表示になっていると思います。 HTMLとcss […]

スマホアプリ

Android Studioでベクター画像を登録しよう

Androidアプリを作成しているとアプリ内のアイコン画像を追加したい、ということありますよね。 そんな時は画像の解像度を気にせず使用できる、ベクター画像を使用すると便利です。 Android Studioでは、ちょっとした手順を踏めばベクター画像をdrawableリソースの中にxmlファイルとして生成してしてくれます。 簡単なので、早速進めてみましょう。 目次1 Android Studioを開こう2 ベクター画像の登録画面を開こう3 クリップ・アートで登録してみよう4 ロ […]

マークアップ

属性セレクターを使ってファイルごとにアイコンをつけよう!

例えばpdfのアイコンをつけたいときに『pdfIcon』をというclassをつけて表示させる、という方法があります。 ただ動的に表現したい場合などにちょっと不便だなと思うこともあるかと思います。 そんな時は属性セレクターを使ってファイルごとにアイコンをつけることができます。 早速属性セレクターを使ってみよう 属性セレクターはを使えば指定された値が存在していたら指定されたcssを適用する、という感じの動作をしてくれます。 書き方としては「属性$=”値”」 […]

株式会社8bit (エイトビット)

東京都目黒区でWebサイト制作、Webシステム開発などを行っております。
コーポレートサイトやWebサービスの企画・提案を得意としており、自社での経験を元にアイデアをカタチにするお手伝いをさせていただいております。

Web制作に関するご相談はお気軽にどうぞ

弊社に制作をご依頼いただく際の費用感をご確認いただける、
見積りシミュレーションをご用意いたしました。