WordPress のウィジェットプラグインの開発

wordpress
  • ????????????????????

このエントリーは wordpress のウィジェットの開発の最初の一歩についてのメモです。
単純にサイドバーに Hello world を表示するウィジェットを作ってみましょう。
ウィジェットを作るのは難しそうなイメージがありましたが、Hello world 程度なら次のような比較的短いコードで実装できました。

ソースコード

<?php
/*
 Plugin Name: Simple sidebar plugin
 Plugin URI: http://www.singularpoint.org/blog/
 Description: Simple sidebar plugin
 Version: 0.1
 Author: flyio
 Author URI: http://www.singularpoint.org/blog/
*/

// プラグインの初期化関数(plugins_loaded アクションにフックされる)
function ssp_init(){
    $base_options = array('classname' => 'sidebar-content-widget',
                          'description' => 'This is my first sidebar widget plugin.');
    // 'Simple sidebar' がウィジェットの画面に表示される名前
    $widget_name = __('Simple sidebar','simple-sidebar');
    wp_register_sidebar_widget('simple-sidebar', $widget_name, 'sidebar_content');
}

// サイドバーのコンテンツの表示関数
function sidebar_content(){
    echo '<h2>Simple sidebar widget</h2>';
    echo "Hello world! This is my first sidebar widget!";
}

// プラグインロード時に ssp_init を呼び出す
add_action('plugins_loaded','ssp_init');
?>

これだけです。ほとんど解説する必要すらないくらい簡単ですね。これを通常のプラグインと同様にインストールして、有効化してください。

完成したプラグインのチェック

ダッシュボードから「外観」 → 「ウィジェット」 を開くと、こんなかんじでウィジェットの画面にも表示されます。”Single sidebar” というのが今回作ったウィジェットです。これをサイドバーにドラッグしてください。

ウィジェットの画面

実際のブログ上での表示は次のような感じになります(一番下)。スタイルが統一されていませんね。このあたりについては今回は扱いません。

時間があるときにもう少し踏み込んだことについても書いてみようと思います。

はてなブックマーク - WordPress のウィジェットプラグインの開発
Pocket

  • Great Seven Orange

    サイドバーに何か表示するプラグインが作りたかったのですが、この記事のお陰で作ることができました。
    ありがとうございます。