hiromasa.zone : o)

2005/11/13 Sunday 投稿時の月齢:11.0  月名:十二日月  潮汐:中潮 Moon:11.0[十二日月]今日の心技体 : 好調期低調前不安定期好調期

WordPress プラグイン作成時のノウハウ – 中編 – このエントリをはてなブックマークに追加このエントリをdel.icio.usに追加

日記 - ひろまさ @ 0:12

WordPress プラグイン作成時のノウハウ – 中編 – です。(諸事情により後編ではなく中編に…)

前回はこちら、

WordPress プラグイン作成のノウハウ – 前編 –

ではまず、wp-hatena のソースを見る前に、この世で一番簡単であろう hook を使うプラグインを書いてみます。 wp-hatena のほうは小技が少しはいっているため、ちょっと後回しにします。 🙂

ここでサンプルにするのは、驚愕の「投稿時間に “☆” を無意味に付けるプラグイン」。

以下がコードになります。

  1.  <?php
  2.  /*
  3.  Plugin Name: Star Time
  4.  Plugin URI: http://zone.maple4ever.net/blog/
  5.  Description: 投稿時間に "☆" を無意味に付けるプラグイン
  6.  Author: hiromasa
  7.  Version: 1.0
  8.  Author URI: http://zone.maple4ever.net/blog/
  9.  */
  10.  
  11.  /****************************************************
  12.   * WP の the_time hook に startime関数を追加します。
  13.   ***************************************************/
  14.  add_filter('the_time', 'startime');
  15.  
  16.  /****************************************************
  17.   * startime 関数を定義します。
  18.   ***************************************************/
  19.  function startime($time) {
  20.     
  21.      $hosi = "";
  22.      $newtime = $hosi . $time . $hosi;
  23.     
  24.      return $newtime;
  25.     
  26.  }
  27.  ?>

実行結果はこんな感じです。

結果

・・・。 まぁサンプルということでお許しを。 ☆の部分だけご確認下さい。

では気を取り直してソースを最初から見ていきましょう。 まずは先頭のコメント行です。

  1.  <?php
  2.  /*
  3.  Plugin Name: Star Time
  4.  Plugin URI: http://zone.maple4ever.net/blog/
  5.  Description: 投稿時間に "☆" を無意味に付けるプラグイン
  6.  Author: hiromasa
  7.  Version: 1.0
  8.  Author URI: http://zone.maple4ever.net/blog/
  9.  */

たかがコメント、されどコメント。 実は WordPress はこのコメント形式を見てプラグインを認識します。ということでこの形式を壊さないように必要な情報を埋め込んでいます。このコメント行さえあれば、とりあえず WordPress のプラグインとしては成立するわけです。(有効化してもなんにも起きませんが…)

次は、”hook を 登録” する部分です。

  1.  /****************************************************
  2.   * WP の the_time hook に startime 関数を追加します。
  3.   ***************************************************/
  4.  add_filter('the_time', 'startime');

ここでは、”投稿時間” の改変をしたかったので the_time という hook を利用しています。 また、”したいこと”が書いてある関数名(startime)を add_filter で指定します。

そして、”したいこと” が書いてある関数(startime)の定義です。ちなみに関数名は別で使っていないものであればなんでもかまいません。(かぶらないような名前で…)

  1.  /****************************************************
  2.   * startime 関数を定義します。
  3.   ***************************************************/
  4.  function startime($time) {
  5.     
  6.      $hosi = "";
  7.      $newtime = $hosi . $time . $hosi;
  8.     
  9.      return $newtime;
  10.     
  11.  }

function startime までは良いですが、その後の ($time) というのはなんでしょう? 実は WP の(フィルター)hook の多くは “現在までの処理結果” をこのように引数で渡してきます。 つまり、$time には投稿時間が入ってくることになります。($ではじまる変数の名前は適当につけて OK です)

ここでは投稿時間に☆をつけたいわけなので、$time を挟む形で☆をつけて・・・。

最後に、return $newtime; ということで WP に結果を返してあげます。ちなみに、この return をしなかった場合は、投稿時間が”からっぽ” になります。

たとえば、同じ the_time hook を使うプラグインがもう一個あった場合で優先順位がこのプラグインより低かった場合、次のプラグインの $time には “☆”付の投稿時間が渡されます。

「前編」で “数珠繋ぎ” といっていた実際の動きはこのあたりのことになるわけです。 おそらくこのプラグインの後ろにまわったプラグインは、投稿時間に☆なんかついてくることを想定していないので困ったことになるでしょう。。 こういうことを回避するため、このような後方に影響を与えそうなプラグインの場合は優先順位をありえないくらい後ろ(1000とか)に設定するというテクニックを使うことが多いです。

さて、このプラグインを導入すると、投稿時間が “☆投稿時間☆” となってサイトに表示されます。 the_time hook はサイト内の全ての投稿時間を表示されるときに呼び出されますので、このプラグインによってサイトは☆だらけの様相を呈してくるわけです。 🙂

ここまで読んでいると、WP から hook に登録した関数に “何が渡されてくるのか” という疑問が沸々とわいてくると思うのですが、この辺はドキュメントをみれば分かるようになっている…

Plugin API < WordPress Codex

ハズなのですが、結構まだ書いていない(TBD) 部分も多く、割と勘でやってみたり、他の方が作られたプラグインを参考にすることが多いです。 🙂

てなわけで、後編に続く…

[続き..]

WordPress プラグイン作成のノウハウ – 後編 –

3 Comments

Trackback

  1. From: PHPの勉強にWordPressのプラグインを作ってみる « Waviaei - 2006/5/20 Saturday Nighttime (Pingback)

    […] 先ほどはアクション・フックを使ったので、今度はフィルター・フックを使ってみる。ひろまささんの、☆をつける「startime」と全く同じことをするとただ単にコピペしただけになるので、ちょっと違うのにしてみる。プラグイン名から察しがつくとは思いますが、アクティベートすると記事を大阪弁にしてくれるプラグインです。もちろん初めからそんな大掛かりなプラグインを目指すのではありません。シンプルに、記事中の「です。」を「やねん。」に変えます。もちろんデータベースにあるオリジナルの記事に手を加えるのではなく、動的にページを作成した際に「です。」を「やねん。」に変換します。 […]

  2. From: 【自作Plugin】☆タイトル | WordPress入門記 - 2010/3/25 Thursday Daytime (Pingback)

    […] 以下のサイトば参考にさせてもろうたとよ。参考:http://zone.maple4ever.net/blog/archives/441/ This entry was posted in WordPress, プラグイン. Bookmark the permalink. Post a comment or leave a trackback: Trackback URL. « ☆【自作Plugin】博多弁コンバーター☆ […]

  3. From: プラグインの関数記述方法 - Doluck! - 2011/5/27 Friday Nighttime (Pingback)

    […] 参考にさせていただいたのは hiromasa.zone さんの記事。 […]

Comment


このサイトはコンテンツをフリーズしました。トラックバック・コメントは閉じられています。

新しいサイトは、

hiromasa.another :o)

です。 :-)

このサイトについて

このブログは引っ越しを行いコンテンツはフリーズしています。hiromasa.anotherへどうぞ。

Powerd By WordPress

We (Heart) WordPress

WordPressME Logo
WordPress Plugins

ブログ内検索

Todays Popular

WordPress Ring

はてなリング - WordPress -

情報

31 queries. 0.440 seconds.

このページの先頭へ