説明
パラメータ
- $argsサイドバーの属性情報を連想配列または文字列で指定。属性情報の内容は次の通り。
属性名 意味 省略時の値 name サイドバー名 __('Sidebar #n') id サイドバーID sidebar-#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]サイドバーの後タグ ''
返り値
サイドバー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は本関数のパラメータに未指定の規定値を加えた内容が格納される。ソースファイル
/wp-includes/widgets.php最終更新 : 2020年12月17日 16:48
関連
お勧め
6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)
バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。
固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)
固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。
Fotepo:プラグイン作ってみました(2019年9月19日 更新)
仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。
カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)
サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。