ショートコードAPIは WordPress 2.5 で追加されたプラグインAPIです。
このAPIを使用するには、まずプラグイン独自のショートコードハンドラ関数を記述します。
ショートコードのデフォルト属性を設定し、取り込むためのヘルパー関数 shortcode_atts() が用意されているため、非常に簡単にショートコードハンドラ関数を作成できます。
記述したショートコードハンドラ関数を add_shortcode() 関数で登録してやればプラグインとして使用できるようになります。
例えば、<a> タグを生成する簡単なショートコードプラグインを作ってみましょう。
01 | function my_shortcode_url($atts, $content = null) { |
02 | extract(shortcode_atts(array( |
03 | 'href' => 'http://' , |
04 | 'title' => '' , |
05 | ), $atts)); |
06 | $href = esc_attr($href); |
07 | $title = esc_attr($title); |
08 | return "<a href="\"$href\"".(" !empty($title)="" ?="" "="" title="\"$title\"">" : '>' ).$content.'</a>'; |
09 | } |
10 | add_shortcode("url", "my_shortcode_url"); |
これで、本文中に
[url href="http://dogmap.jp/" title="dogmap.jp"]dogmap.jp[/url]
と書くと
<a href="http://dogmap.jp/" title="dogmap.jp">dogmap.jp</a>
に変換してくれます。
WordCamp Yokohama 公式サイトのユーザー登録画面、ログイン画面のカスタマイズはショートコードAPIを使用して実現しています。
参加者一覧画面で、登録ユーザーの一覧情報を表示する際にも、ショートコードAPIを使用しています。
ショートコードAPIを使用した WordPress プラグインを簡単に作るためのジェネレータを公開しています。
使用方法 http://dogmap.jp/AZ
ショートコードプラグインのサンプルとしてお使いください。
もちろん、このジェネレータで作成したプラグインは、自由に公開してもらって問題ありません。