MENU
  1. Home
  2. WordPress リファレンス
  3. Hook
  4. widgets_init

widgets_init

広告
Hook

widgets_initは、WordPressでウィジェット領域（サイドバー）を登録する際に使われるフックです。テーマやプラグインの開発者はこのフックを利用して、ウィジェットエリアを自由に追加・管理できます。

目次

機能の説明

widgets_initは、WordPressがウィジェットを初期化するタイミングで発火するフックです。このフックに登録した関数を使うことで、サイドバーやウィジェットエリアを追加し、カスタムウィジェットの登録を行います。

シンプルなコード例

add_action('widgets_init', 'register_custom_sidebar');
function register_custom_sidebar() {
    register_sidebar(array(
        'name' => 'カスタムサイドバー',
        'id' => 'custom-sidebar',
        'before_widget' => '<div class="widget">',
        'after_widget' => '</div>',
        'before_title' => '<h2 class="widget-title">',
        'after_title' => '</h2>',
    ));
}

このコードでは、widgets_initフックを使い、register_sidebar()関数を通して「カスタムサイドバー」を追加しています。before_widgetやbefore_titleのオプションで、ウィジェットのHTML構造を指定できます。

使い方の解説

widgets_initは、ウィジェットエリアやカスタムウィジェットを登録するために使用されます。add_action()でこのフックに関数を登録し、その関数内でregister_sidebar()やregister_widget()を使うことで、さまざまなウィジェットを設定できます。

引数

$tag (string)

このフック自体には引数はありません。add_action()でフックに関数を登録するだけです。

戻り値

void

widgets_initフック自体は値を返しません。登録した関数を通して、ウィジェットエリアが設定されます。

オプション

このフック自体にオプションはありません。

使用例

add_action('widgets_init', 'register_footer_widgets');
function register_footer_widgets() {
    register_sidebar(array(
        'name' => 'フッターエリア',
        'id' => 'footer-area',
        'before_widget' => '<div class="footer-widget">',
        'after_widget' => '</div>',
        'before_title' => '<h3>',
        'after_title' => '</h3>',
    ));
}

この例では、footer-areaというIDでフッター用のウィジェットエリアを登録しています。このエリアに追加されるウィジェットは、<div class="footer-widget">内に挿入され、タイトルは<h3>タグで囲まれます。

一緒に使うことが多い関連タグ

register_sidebar()

register_sidebar()は、新しいウィジェットエリアを登録するためのテンプレートタグです。

register_sidebar(array(
    'name' => 'サイドバー',
    'id' => 'sidebar-1',
    'before_widget' => '<aside class="widget">',
    'after_widget' => '</aside>',
    'before_title' => '<h2 class="widget-title">',
    'after_title' => '</h2>',
));

このコードは、管理画面から利用可能なサイドバーエリアを登録します。widgets_initフックを使ってこの関数を呼び出します。

追加情報を取得したい場合

カスタムウィジェットを作成する場合、register_widget()関数を使います。これにより、独自のウィジェットを定義して利用できるようになります。

register_widget() でカスタムウィジェットを登録

add_action('widgets_init', function() {
    register_widget('My_Custom_Widget');
});

class My_Custom_Widget extends WP_Widget {
    function __construct() {
        parent::__construct('my_custom_widget', 'カスタムウィジェット');
    }

    function widget($args, $instance) {
        echo '<div class="my-widget">Hello, Widget!</div>';
    }
}

このコードでは、register_widget()を使ってカスタムウィジェットを登録しています。My_Custom_Widgetクラスを作成し、その中でウィジェットの表示内容を定義しています。

出力できる情報

  • name: ウィジェット名
  • id: ウィジェットのID
  • class: ウィジェットに適用されるCSSクラス

想定されるトラブル

ウィジェットが表示されない

idが重複していないか確認し、before_widgetやafter_widgetのHTMLが正しいかチェックします。

ウィジェットエリアが管理画面に表示されない

widgets_initフック内で正しい関数を呼び出しているか確認してください。

複数のウィジェットエリアが意図した順序で表示されない

テーマファイルでウィジェットエリアを呼び出す際の順番を調整します。

Q&A

複数のウィジェットエリアを登録できますか？

はい。register_sidebar()を複数回呼び出すことで、複数のウィジェットエリアを登録できます。

ウィジェットの優先表示順を変更するには？

ウィジェットエリア内のウィジェットの順序は、管理画面でドラッグ＆ドロップで変更できます。

ウィジェットのスタイルを変更するには？

before_widgetやbefore_titleオプションで、独自のHTML構造やCSSクラスを追加してください。

まとめ

widgets_initは、WordPressでウィジェットエリアを登録するために不可欠なフックです。

register_sidebar()と組み合わせて使用することで、サイドバーやフッターなどのウィジェットエリアを簡単に設定できます。さらに、register_widget()を使うと、独自のウィジェットを作成し、サイトに機能を追加することが可能です。

Hook
よかったらシェアしてね！
  • URLをコピーしました！
目次