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



お勧め

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。