2024年06月14日
WP関数:register_sidebar()
この関数の説明
WP関数の register_sidebar() は、管理画面の「外観→ウィジェット」で表示するサイドバーを定義します。
関数
register_sidebar( $args )
パラメータ
$args (配列)(オプション)
連想配列でウィジェットを定義します。
<指定できるキー>
指定できるキー | 説明 |
'id' | このサイドバーを呼び出す id名 を指定します。
利用できる文字は空白を除く半角英数字です。 省略した場合は自動的にカウントアップする整数値になります。 |
’name’ | 管理画面の「外観→ウィジェット」画面に表示されるサイドバー名 |
'description' | サイドバーの名の下に表示される説明文
この中に id名 を含めておくとプログラム作成時に悩みません。 |
■上記以外にもキーはあります。その他のキーはここをを参照してください。
戻り値
なし
事例
①サイドバーを定義します。
functions.php に下記を設定します。
function set_widgets() { register_sidebar( ['id' => 'post' ,'name' => '投稿ページ' ,'description' => 'id = =post'] ); register_sidebar( ['id' => 'category' ,'name' => 'カテゴリページ' ,'description' => 'id = category'] ); register_sidebar( ['id' => 'archive' ,'name' => 'アーカイブページ' ,'description' => 'id = arxhive'] ); register_sidebar( ['id' => 'footer' ,'name' => 'フッタ用' , 'description' => 'id= footer']) ; } add_action('widgets_init', 'set_widgets');
■上記設定でウィジェット画面は下図のようになります。
関連情報
上記で設定したサイドバーを呼び出す関数はdynamic_sidebar()になります。