【WordPress】プラグイン開発の基本 – 校正支援プラグインを作る1

wordpress-logo

WordPressは全Webページの約1/4、WordPressやJoomla、DrupalなどのCMS市場では6割を占めるシェアを誇ります。

参考:Usage of content management systems for websites

こんなに多くのサイトで使用されている理由は、WordPress本家の開発が活発でどんどん使いやすいものになっていることはもちろんですが、「プラグイン」と「テーマ」による拡張性が大きな要因だと考えられます。

ここでは簡単なプラグインを実際に作成する手順を紹介します。

スポンサーリンク

今回作るもの

今回はYahoo! APIの校正支援APIを使用して、投稿画面で校正支援を行えるプラグインを作成していきます。

具体的には以下を満たすプラグインを作成します。

  1. 公開前の記事の編集画面に「文章チェック」ボタンを配置
  2. 「文章チェック」ボタンを押すと校正支援APIの結果が表示される
  3. 管理画面左メニューの設定に校正支援APIを使用するためのIDの設定ページを作成

まず最初にやること

まずはプラグインの原型となるPHPファイルを作成します。

WordPressではプラグインフォルダ(wp-content/plugins/)下にある、プラグインの名前や説明などの情報が先頭に書かれたPHPファイルをプラグインファイルとして認識します。

そのままプラグインフォルダ(wp-content/plugins/)にファイルを作成しても良いのですが、cssやjs等をまとめておくためにyproofreadingフォルダを作成します。

その中にyproofreading.phpを作成し、プラグイン情報を記述します。

今回作成するのはYahoo! APIを使用した校正支援プラグインなので、名前は「YProofreading」にしました。

ここで一度プラグインのページを表示してください。

WordPressにプラグインとして認識されているはずです。

特にまだ何も機能はありませんが「有効化」しておきましょう。

設定画面を作る

次に校正支援APIを使用するためのアプリケーションIDを設定する画面を作成します。

アプリケーションIDはこちらを参考に取得しておいてください。

独自の設定画面を作成するにはアクションをフックしてメニューを追加する関数や設定項目を追加する関数などを呼び出します。

『アクション』は『フィルタ』とともにWordPressのプラグインやテーマの拡張には欠かせない機能です。

この『アクション』と『フィルタ』をフックすると、WordPressのプログラム内に仕込まれている

で実行されます。

アクションの方は結果を返さない関数の実行、フィルタの方は値をいじって結果を変えるような使い方をします。

よく使うフィルタ・アクションは別の機会に紹介します。

設定画面は以下の2つのページを参考にしています。

管理メニューの追加

Settings API

早速実際のコードを見てみましょう。

なおPHP5.3以上を対象としています。

先ほど作成した yproofreading.php に上のコードを追加して保存します。

管理画面をリロードすると左メニューの「設定」に「校正支援」の項目が追加されます。

「校正支援」を選択すると「Yahoo API 設定」を行う画面になります。

実際にあらかじめ取得したアプリケーションIDを入力して保存してみましょう。

まだ取得していない方はこちらを参考に取得してみてください。

校正支援プラグインを作る2

コメント