Nullyのぶろぐ

仙台で働くエンジニアの日記

WordPress3.3が発表されたので、EditorAPIをちょっとだけ使ってみた

いつの間にかWordPress3.3 Sonnyが公開されていたので、今回から追加されたEditor APIの一部を利用してみた。

WordPress3.3 SonnyのSonnyとは、JazzSaxophonistのSonny Stittのことらしい。

Jazzはバーボン飲みながら聞くに限る...!

EditorAPIとは

EditorAPIは今まで投稿タイプなどにつけるのもちょっと手間だった、エディタ(TinyMCEを利用したエディタ)をワンツーで取り付けることができるAPIです。

オプションも豊富で、開発者視点からも楽をすることのできるAPIです。

使い方

EditorAPIを利用するには「wp_editor」という関数を呼び出すだけで利用することができます。

wp_editor($content, $editor_id, $settings);

オプションページに新しいメニュー項目を追加して、そのページでエディタを表示するには以下のようなコードになります。

add_action("admin_menu", "sample_add_nav");

function sample_add_nav() {

add_options_page("Sample", "Sample", "edit_posts", __FILE__, "sample_editor_page");

}

function sample_editor_page() {

// コンテンツ内容を取得したりするなど

wp_editor($content, "sample_editor_id");

}

引数

wp_editor関数は引数を3つ取ります。

  • $content:エディタに反映するコンテンツ内容
  • $editor_id:HTMLのID属性に利用するID
  • $settings:エディタに関する設定

の3つです。

$contentは入力された文字をそのままセットするだけ、$editor_idは利用するエディタに見合ったIDを指定するだけです。

$settingsはエディタの振る舞いや、エディタ内容の振る舞いなどを設定することができます。

利用できるオプションについてはこちらの「Argument」の項を御覧ください。

終わりに

今回のアプデでは投稿タイプで利用される機会の多いエディタがAPI形式として提供されたのが個人的には一番嬉しいです。

ユーザーからすれば、今まで若干煩わしかった画像のアップロードに関しても格段に良くなっています。

より詳しい更新内容はコチラからご覧になれます。