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

お勧め

自動生成される抜粋からテーブルブロックの内容を除外する（2022年4月6日 更新）

標準テーマである「Twenty Twenty-Two」や「Twenty Twenty-One」では、トップページやアーカイブページにおいて投稿情報を表示する際、その抜粋を使っている。とある投稿にテーブルブロックを入れた際、トップページに表示された抜粋には各セルの内容が列挙され、ちょっとモヤモヤした。

Post-tag automaton：プラグイン作ってみました（2012年12月24日 更新）

みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。

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

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

投稿一覧に「投稿フォーマット」フィルターが追加される（2019年4月12日 更新）

WordPress 5.2 Beta2（以降5.2Beta2）のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」（select要素）が追加されていた。

さくらのVPSでKUSANAGI#2（2018年5月27日 更新）

今回は「前回」の続き。さくらのVPS（メモリー2GB SSDプラン）でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。