プラグイン

投稿画面で、ふりがなを自動入力するプラグインを作成した。
個人ブログ「お菓子の虜」で、お菓子名のふりがなをカスタムフィールドに手入力する手間を、なんとか軽減できないかと思っていたのを実現したものだ。以前はお菓子データをAccessで管理していたため、ふりがなの機能が付いていたのだ。
さて今回のプラグインでは、投稿タイトルを入力しフォーカス移動した際にふりがなが空白であれば、自動的に設定するようにした。カスタムフィールドを使っているので、手修正も可能だ。すでに何かしら入力されている場合はなにもしない。
誰もが欲しい機能ではないものの、本人としてはまずまずの使い心地である。

ふりがなを取得するには、Yahoo! JAPANが提供している「日本語形態素解析」というWeb APIを利用した。プラグインを使う際にYahoo! JAPANのアプリケーション IDを取得し、設定画面から登録する必要がある。

プラグインを初めて公開するということで、PoEditを使いながら翻訳処理もやってみた。
ダウンロード：WP-Furigana ふりがなを自動入力するプラグイン

以前メモしたことのある、ダッシュボードにメニューを追加する方法の詳細。

プラグインに設定画面を追加するには、admin_menuというアクションフックを利用する。add_options_page()でダッシュボードのサイドメニューに項目を追加し、コールバック関数で設定画面を表示する。
設定画面はパラメータを入力するためのフォームとなる。フォームのactionに自分自身のURLを設定しておく。submitされた際にはパラメータがPOSTされてくるので、その場合の処理を入れておく。受け取ったパラメータをupdate_option()で、保存すればよい。すでにパラメータが保存されている場合はget_option()で取得することができるので、それをフォーム内のvalueとして表示する。

さらにplugin_action_linksというフィルタを利用すると、プラグインの管理に”設定”メニューを追加することができる。”設定”がクリックされた場合の処理は、上記のコールバック関数になる。こちらはあってもなくてもよいわりには苦戦した。

[sourcecode language=’php’]
add_action(‘admin_menu’, ‘add_config_page’);

function add_config_page(){

add_options_page(‘MyPlugin’, ‘MyPlugin’, 10, basename(__FILE__), ‘config_page’);
add_filter( ‘plugin_action_links’, ‘filter_plugin_actions’, 10, 2 );
}

function filter_plugin_actions( $links, $file ){

static $this_plugin;
if ( ! $this_plugin ) $this_plugin = plugin_basename(__FILE__);

if ( $file == $this_plugin ){
$settings_link = ‘Settings‘;
array_unshift( $links, $settings_link );
}
return $links;
}

function config_page(){

$my_param = ”;

if( isset( $_POST[‘submit’] ) && isset( $_POST[“my_param”] )){
$my_param = $_POST[“my_param”];
update_option( “my_param”, $my_param);
}
else{
$my_param = get_option(“my_param”);
}

?>

管理メニューの追加 – WordPress Codex 日本語版

DBテーブルのwp_optionsやwp_postmetaに配列っぽいデータが保存されているのを見ることがある。たとえば wp_postmetaでは_”wp_attachment_metadata”というキーに”a:5:{s:5:”width”;s:3:”145″;s:6:”height”;s:2:”74″;s:14:”hwstring_small”;s:23:”height=’65’ width=’128′”;s:4:”file”;s:35:”2010/…”というようなデータが保存されている。画象を添付した際のパスやサイズなどのメタデータである。

この形式を自分でも利用することができる。
例えばwp_optionsに保存するには、
INSERT INTO wp_options(option_id, blog_id, option_name, option_value, autoload) VALUES(null, 0, ‘my_messages’, maybe_serialize( $messages ), ‘yes’)
というようなSQLを実行すればよい。連想配列$messagesをシリアライズしたものをoption_valueにセットする。maybe_serialize()は、WordPressの関数である。

このデータを取得するには、SQLでSELECTして得た値を、
$messages = maybe_unserialize($result->option_value);
とすることで連想配列にセットされる。

ちょっとした情報を保存したいならプラグイン用にテーブルを作成するのではなく、 wp_optionsに保存する手段もあるのだ。Contact Form 7 のコードを見てて、この仕組みがやっと分かった。

WordPressをインストールする際にMySQLに作成されるテーブルのほかに、自作プラグインでもテーブルを作成することができる。アクションフックのregister_activation_hookを定義しておくとプラグインが有効になった際に関数が呼ばれるので、ここでテーブルを作成する。テーブル名にはWordPressの接頭辞を使用すること。
以下は、wp_sampleというテーブルを作成する例。

[sourcecode language=’php’]
function myActivation() {

global $wpdb;

$table_name = $wpdb->prefix . “sample”;
if($wpdb->get_var(“show tables like ‘$table_name’”) != $table_name) {

$sql = “create table ” .$table_name .” (
ID bigint not null auto_increment,
name varchar(64) NOT NULL,
furigana varchar(64) default NULL,
url varchar(64) default NULL,
primary key(ID)
)”;

$results = $wpdb->query($sql);
}
}

register_activation_hook(__FILE__, ‘myActivation’);
[/sourcecode]

プラグインが無効化された際の処理は以下を使用する。
[sourcecode language=’php’]
register_deactivation_hook(__FILE__, ‘myDeactivation_’);
[/sourcecode]

ショートコードとは、記事中に記述することで実行させるプラグインのことだ。有名なショートコードのプラグインに、ソースコードを表示するためにここでも使っている「SyntaxHighlighter Plus」がある。

ショートコードは以下のように記事中に記述する。
[hello color=”red”]ほにゃらら[/hello]

プラグインでは、add_shortcodeで定義した関数を用意する。下の例では、赤い文字で”ほにゃらら”と表示する。この場合の出力はechoではなく、returnとすることに注意したい。
$attsの引数で、属性値を受け取ることもできる。

[sourcecode language=’php’]
function showhello($atts, $content) {
extract( shortcode_atts( array(‘color’ => ”), $atts ));
return ‘

‘;
}

add_shortcode(‘hello’, ‘showhello’);
[/sourcecode]

ショートコードは記事中だけでなく、テーマで使用することもできる。テーマで使用する場合は、 do_shortcode()を使う。
[sourcecode language=’php’]

[/sourcecode]