• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

サイドバー

提供: WordPress Codex 日本語版
2015年7月26日 (日) 17:14時点におけるMiccweb (トーク | 投稿記録)による版 (関数リファレンス)

移動先: 案内検索

このページ「サイドバー」は未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています

サイドバーとは、バージョン 2.2 で導入されたテーマ機能です。テーマによって提供される基本的には縦方向のカラムで、Web ページのメインコンテンツ以外の情報を表示します。通常、テーマにはコンテンツの右または左側に最低1つのサイドバーが含まれています。サイドバーには普通、サイトの管理者がカスタマイズできるウィジェットが配置されます。

関数リファレンス

サイドバーの登録
サイドバーの表示

サイドバーの定義

下記の関数は、サイドバーの機能をテーマ.に加えるのに用いられます。

複数サイドバーの登録

register_sidebars( $count, $args );

現在のテーマで使用する 1 つまたは複数のサイドバーを登録します。多くのテーマはサイドバーが 1 つだけです。 このため、 count のパラメータ値はオプションで、デフォルトは 1 つです。

The $args parameter will be passed to register_sidebar() and follows its format, with the exception of the name, which is treated with sprintf() to insert or append a unique number to each sidebar if count is plural.

For example, the following line will create sidebars name "Foobar 1" and "Foobar 2":

register_sidebars( 2, array( 'name' => 'Foobar %d' ) );

1個のサイドバー登録

register_sidebar( $args );

The optional $args parameter is an associative array that will be passed as a first argument to every active widget callback. (If a string is passed instead of an array, it will be passed through parse_str() to generate an associative array.) The basic use for these arguments is to pass theme-specific HTML tags to wrap the widget and its title. Here are the default values:

$args = array(
	'name'          => sprintf( __( 'Sidebar %d' ), $i ),
	'id'            => "sidebar-$i",
	'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",
);

There are times you might need to call this function instead of register_sidebars(). An example of this would be when you want to give unique names to the sidebars, such as "Right Sidebar" and "Left Sidebar", or when they should be marked up differently. The names appear in the admin interface and are used as an index for saving sidebar arrangement. Please note: sidebar arrangements can be reused and overwritten when another theme is chosen that uses the same sidebar names.

The default before and after values are intended for themes that generate a sidebar marked up as a list with "h2" titles. This is the recommended convention for themes. Themes built using this structure can simply register sidebars without issues in regard to the before and after tags. If a theme cannot be marked up in this way, these tags must be specified when registering sidebars. It is recommended to copy the id and class attributes verbatim so that an internal sprintf call can work and CSS styles can be applied to individual widgets.

テーマにサイドバーを表示する

dynamic_sidebar( $sidebar );

This function calls each of the active widget callbacks in order, which prints the markup for the sidebar. If you have more than one sidebar, you should give this function the name or number of the sidebar you want to print. This function returns true on success, false on failure.

The return value should be used to determine whether to display a static sidebar. This ensures your theme will look good when the Widgets plug-in is not active. Along with a sanity test to prevent fatal errors, below is the recommended use of this function:

<ul id="sidebar">
	<?php if ( ! dynamic_sidebar() ) : ?>
		<li>{static sidebar item 1}</li>
		<li>{static sidebar item 2}</li>
	<?php endif; ?>
</ul>

If your sidebars were registered by number, they should be retrieved by number. If they had names when you registered them, you will use their assigned names to retrieve them.

リソース

関連ページ

サイドバー: is_active_sidebar(), is_dynamic_sidebar(), dynamic_sidebar(), register_sidebars(), register_sidebar(), unregister_sidebar(), wp_register_sidebar_widget() / en, wp_unregister_sidebar_widget() / en, wp_get_sidebars_widgets() / en, wp_set_sidebars_widgets() / en,
テーマサポート: add_theme_support(), remove_theme_support(), current_theme_supports()
テーマ機能: サイドバー, ナビゲーションメニュー, 投稿フォーマット, 投稿サムネイル, カスタム背景, カスタムヘッダー, 自動フィードリンク, html5, コンテンツ幅, editor-style



最新英語版: WordPress Codex » Sidebars最新版との差分