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
    ※#nにはサイドバーのシリアル番号が入る(例:登録時に2つのサイドバーが登録されている場合は3が入る)。

返り値

サイドバーIDを返す。

注意

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

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


使用例

  • サイドバーを登録する。
    <?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

最終更新 : 2019年11月18日 17:07



お勧め

WordPressと組み込まれている主なJavaScriptライブラリのバージョン一覧(2018年5月27日 更新)

WordPressの更新が遅れていたサイトを少し前に更新したところ、jQuery UI sortableを使って拡張したページに不具合が発生しました。WordPressの更新に伴って内部のjQuery UIが更新されたことに起因すると思われ、これを機にWordPressとそれに組み込まれたJavaScriptライブラリのバージョンを確認してみました。

ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

検索ワード「-10,000円」を検索できるようにしたい(2018年5月27日 更新)

とあるサイトで「-10,000円」をキーワードに検索した際、予想と異なるページが表示され、ちょっと驚いた。今回はその原因調査と対策についてまとめてみた。

ダッシュボードのフィードボックスをカスタマイズ(2011年7月8日 更新)

管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する(管理者権限)。