wp_register_sidebar_widget

関数の概要

お好みでウィジェットを登録・利用するために使います。登録したウィジェットは、WordPressの管理画面から「外観」「ウィジェット」画面で使うことができます。

「利用できるウィジェット」にお好みで追加できる

これまで、ウィジェトの登録には「register_sidebar_widget」を使うこともあったのですが、WordPress2.8.0から非推奨となったので、その代替として「wp_register_sidebar_widget」への移行が推奨されています。

ちなみに「register_sidebar_widget」を使ってデバッグモードを有効にすると、以下のようなエラーメッセージが表示されることがあります。

Notice: register_sidebar_widget の使用はバージョン 2.8.0 から非推奨になっています! 代わりに wp_register_sidebar_widget() を使ってください。

使用できるパラメーター

基本的な使い方

登録するウィジェットは「何に使うものか」をわかりやすくするため、optionsパラメーターを指定すると親切だと思います。

wp_register_sidebar_widget(
 'widget01',
 __('widgetcontent'),
 'widget_content01',
 array(
 'description' => 'オリジナルウィジェット' // ウィジェットの説明を入れたりすると便利です
 )
);

コールバック関数

上記のコードの例では、第3引数でコールバック関数として「widget_content01」関数を呼び出しています。

function widget_content01($args) {
 echo $args['before_widget'];
 echo $args['before_title'] . 'ウィジェットのタイトル' . $args['after_title'];
 echo $args['after_widget'];
 echo "ウィジェットの内容";
}

うまく登録されると、下の画像のようにウィジェットの画面で使えるようになります。

ウィジェットが登録された

ウィジェットは便利ですね

「このウィジェットをドラッグ＆ドロップすれば使えるよ」みたいな案内ができるので、お客さんの要望にあったウィジェットをあらかじめ作って納品することは多いです。

参考リンク

wp_register_sidebar_widget