register_sidebar

（2.2.0以降）
register_sidebar - サイドバーを登録する

説明

string register_sidebar( [ mixed $args = array() ] )
サイドバーを登録する。

パラメータ

  • $args
    サイドバーの属性情報を連想配列または文字列で指定。属性情報の内容は次の通り。
    属性名意味省略時の値
    nameサイドバー名__('Sidebar #n')
    idサイドバーIDsidebar-#n
    descriptionサイドバーの説明''
    classサイドバーに追加するクラス名''
    before_widgetウィジェットの前タグ<li id="%1$s" class="widget %2$s">
    after_widgetウィジェットの後タグ</li>\n
    before_titleサイドバータイトルの前タグ<h2 class="widgettitle">
    after_titleサイドバータイトルの後タグ</h2>\n
    before_sidebar[5.6.0]サイドバーの前タグ''
    after_sidebar[5.6.0]サイドバーの後タグ''
    ※#nにはサイドバーのシリアル番号が入る（例：登録時に2つのサイドバーが登録されている場合は3が入る）。

返り値

サイドバーIDを返す。

注意

内部では add_theme_support( 'widgets' )を実行し、テーマで「ウィジェット」メニューが有効になる。
デフォルトではタイトルは<h2>タグになるので、ページのHTML構造にあわせてパラメータ$argsの'before_title'と'after_title'に適切なタグを指定する。

[4.2.0]パラメータで'id'要素を指定することが推奨となった。

[5.6.0]パラメータ$argsに'before_sidebar'と'after_sidebar'が追加された。

使用例

  • サイドバーを登録する。
    <?php register_sidebar( ); ?>
  • 属性を指定してサイドバーを登録する。
    <?php register_sidebar( array( 'name'=>'メインサイドバー' ) ); ?>

フィルター

[5.3.0]パラメータとデフォルト値をマージする前に'register_sidebar_defaults'フィルターを呼び出す。パラメータ$defaultsにはデフォルト値の連想配列が格納されている。 
$sidebar = wp_parse_args( $args, apply_filters( 'register_sidebar_defaults', $defaults ) );

アクション

[3.0.0]本関数の終了直前に'register_sidebar'アクションを呼び出す。パラメータ$sidebarは本関数のパラメータに未指定の規定値を加えた内容が格納される。
do_action( 'register_sidebar', $sidebar );

ソースファイル

/wp-includes/widgets.php

最終更新 : 2020年12月17日 16:48

関連

参考

Code Reference: register_sidebar

お勧め

Contact Form 7に確認フェーズを（2012年12月16日 更新）

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript（jQuery）を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

投稿一覧に独自リンクを追加する（2013年10月16日 更新）

管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。

HTML編集モードに定型文ボタンを追加する（2011年6月1日 更新）

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

投稿日の検索が自由自在に（2015年3月7日 更新）

WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス（もちろん query_posts関数でも）で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。

プラグインのヘッダー情報を国際化対応しよう（2018年5月27日 更新）

バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。