ここは僕の冷蔵庫。後はあれして食べるだけ。

I love the frozen FOOD.

実際にプラグインを作り始めるときの手順(?)、第一歩(?)的なお話です。
shortcodeを使ったとても簡単なプラグインを1つ作成するのが、ここでの目標です。

まずはお断り

実際に仕事などで運用しているサイトで、本記事で紹介する内容を試さないでくださいね。まずはサンプルサイトなど、サイト自体が動作しなくなってもあまり問題ないところでお試しください。
例によって当たり前ですが、損害等が出ても、私は保障しかねます。

レジュメ

プラグインを作成するにあたり、下記のことについて説明していきます。

  1. 配置する場所の説明
  2. 作成する時のルール
  3. プラグインサンプル作成
  4. プラグインの活性化
  5. 実際に動かしてみる
  6. プラグイン停止

配置する場所の説明

wordpressのプラグインは、下記のディレクトリに配置することがルールになってます。

wordpressインストールディレクトリ /

wp-content
plugin

参考 : wp-contentディレクトリについて

このpluginというディレクトリの下に、作成するプラグインの専用ディレクトリを作る感じです。
例えば、markSampleというプラグインを作成する場合、下記にmarkSampleという名前のディレクトリを作ります。
wp-content
plugin
markSample

テーマの名前とディレクトリの名前は、実際には同じにしなくても構いませんが、ここでは便宜上同じとして説明していきます

作成する時のルール

php言語で、プラグインを作成していきます。
が、1つお約束事項がでてきます。phpで機能を定義したファイルの冒頭に、定型文字を入れる必要があります。

<?php
/*
Plugin Name: マーカーサンプルプラグイン
Plugin URI: http://www.nemuizo.com/
Description: 指定した文字をボールドにする
Version: 0.1
Author: gonzo/Gem-one
Author URI: http://www.gem-one.com/
*/

wordpressは、この情報をひろって、これがプラグインだということを理解しますので、入れとかないといけません。
尚、ここで記載した内容は、wordpressの管理画面で表示されます。

  • Plugin Name:
  • 実際のプラグインのフルネームを記載します。今回は「マーカーサンプルプラグイン」と名付けました
  • Plugin URI:
  • このプラグインを紹介しているページなど。今回は、http://www.nemuizo.com/
  • Description:
  • プラグインの説明を記載。
  • Version:
  • プラグインのバージョンです。今回は、0.1にしときました
  • Author:
  • プラグインを作った人を記載します
  • Author URI:
  • プラグインの作った人のHPなどを記載

プラグインサンプル作成

では実際にプラグインを作成していきます。
が、あまり難しいのだと作成するプラグインの機能説明記事になってしまうので、今回は、簡単なものをつくります。

機能

wordpressの記事中で

あい[mark]うえ[/mark]お

とすると、

あいうえ

と表示されるプラグインとします。

ソースコード

markSampleのディレクトリに、mark.phpという名前で下記のソースを保存します。

<?php
/*
Plugin Name: マーカーサンプルプラグイン
Plugin URI: http://www.nemuizo.com/
Description: 指定した文字をボールドにする
Version: 0.1
Author: gonzo/Gem-one
Author URI: http://www.gem-one.com/
*/
add_shortcode('mark', 'gemone_mark'); /*この名前は、このブログの中で完全にユニークに!*/

function gemone_mark( $atts, $content = null )
{
    return '<strong>'.$content.'</strong>';
}
?>

プラグインの活性化

ソースを先ほどのディレクトリに保存したら、管理者でwordpressにログインし、プラグインの一覧をみてみてください。

管理メニューの「プラグイン」から「インストール済みのプラグインの一覧」を選択くださいませ。

リストを見ると、

というアイテムがありませんか?
ない場合は、プラグインのソースを再度見直してみてください。

有効化(活性化)

プラグインを保存しただけでは動作しません。「有効化」(活性化)しない限り、wordpress上で動作はしません。
では、早速プラグインを有効化(活性化)してみましょう。
先ほどの「マーカーサンプルプラグイン」の下に「有効化」という文字が見えますよね。そこをクリックしてみてください。
もし、下記のようなメッセージが冒頭にでてくるようであれば、再度、プラグインのソース mark.php を確認してください。ソース、打ち間違えてると思いますよ。


成功している場合は、ページの冒頭に下記のメッセージがでてきます。

そして、プラグインの一覧をみると

となっていることが確認できます。
これで無事に有効化されました。

実際に動かしてみる

記事を新規作成して、

あい[mark]うえ[/mark]お

と入力してみてください。
プレビュー表示をしてみましょう。
いかがでしょうか?

あいうえ

って出てきましたでしょうか?

プラグイン停止

インストールしたプラグインを停止する場合の説明です。
有効化と同様、まずはプラグインのリスト表示をします。
先ほど有効化した、markSampleを停止させてみます。


一覧上で、上記表示があると思います。「マーカーサンプルプラグイン」というタイトルの直下に「停止」という文字があります。ここをクリックしてください。このプラグインは停止されます。
尚、アンインストールする場合(markSampleのディレクトリごと消し去る場合)は、この「停止」行為をしてから、ディレクトリごと削除しちゃいましょう。
「停止」を実施しなくとも、ディレクトリ削除して大丈夫といえば大丈夫ですが、あまりお勧めはしません。

まとめ

プラグイン作成の大きな枠組み理解いただけたでしょうか?
今回は、ボールドにするだけの簡単な例で恐縮ですけども(笑)
今回は、shortcodeを使った例ですが、

  • ウィジェット作成
  • wordpressの振舞を変更(各種フック系機能増強)
  • 管理画面拡張

など、アイデア次第で色んなことができますよ。
ご参考になれば!

参考

参考記事