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

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

「関数リファレンス/register sidebar」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(整形・リンク調整。未翻訳)
(翻訳済み)
1行目: 1行目:
 
{{NeedTrans}}
 
{{NeedTrans}}
== Description ==
+
== 説明 ==
  
Builds the definition for a single sidebar and returns the ID.
+
単一サイドバーを定義し、ID を返します。
  
== Usage ==
+
== 使い方 ==
  
 
  <?php register_sidebar( $args ); ?>
 
  <?php register_sidebar( $args ); ?>
  
===Default Usage===
+
===デフォルトの使い方===
  
 
<pre>
 
<pre>
21行目: 21行目:
 
</pre>
 
</pre>
  
(No backslashes before the double quotes, the Codex's PHP highlighter seems to be screwy.)
+
(二重引用符の前にバックスラッシュはありません。Codex の PHP ハイライトがおかしいようです。)
  
== Parameters ==
+
== パラメータ ==
  
{{Parameter|$args|string/array|Builds Sidebar based off of 'name' and 'id' values.|optional}}
+
{{Parameter|$args|文字列/配列|'name' 'id' 値からサイドバーを作成|オプション}}
:* <tt>name</tt> - Sidebar name.
+
:* <tt>name</tt> - サイドバー名
:* <tt>id</tt> - Sidebar id.
+
:* <tt>id</tt> - サイドバー id
:* <tt>description</tt> - Sidebar description. (Since 2.9)
+
:* <tt>description</tt> - サイドバーの説明 (2.9以降)
:* <tt>before_widget</tt> - Text to place before every widget.
+
:* <tt>before_widget</tt> - ウィジェットの前のテキスト
:* <tt>after_widget</tt> - Text to place after every widget.
+
:* <tt>after_widget</tt> - ウィジェットの後のテキスト
:* <tt>before_title</tt> - Text to place before every title.
+
:* <tt>before_title</tt> - タイトルの前のテキスト
:* <tt>after_title</tt> - Text to place after every title.
+
:* <tt>after_title</tt> - タイトルの後のテキスト
  
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.
+
オプション $args パラメータは連想配列で、アクティブウィジェットコールバックの最初の引数として渡されます。 (配列でなく文字列が渡された場合は、parse_str() を経て連想配列として渡されます。) これらの引数の基本的な使い方は、ウィジェットとタイトルを包む、テーマ固有の HTML タグを渡すことです。
  
== Notes ==
+
== ==
  
* The only times you might need to call this function instead of [[関数リファレンス/register_sidebars|register_sidebars()]] are when you want to give unique names to sidebars, such as “Right Sidebar” and “Left Sidebar”, or when they should be marked up differently. The names only appear in the admin interface but they are also used as an index for saving the sidebar arrangements. Consequently, sidebars can have their arrangements reused and overwritten when another theme is chosen that uses the same names.
+
* [[関数リファレンス/register_sidebars|register_sidebars()]] ではなく、この関数を呼び出す必要があるケースは、サイドバーに一意の名前、たとえば “Right Sidebar” “Left Sidebar” を与えるときや、異なるマークアップが必要なときに限られます。名前は、管理画面でのみ表示されますが、サイドバーの変更を保存するインデックスとしても使用されます。このため、サイドバーに加えた変更は、同じ名前を使用する別テーマを選択した時に、再利用され、上書きされます。
  
* The default before/after values are intended for themes that generate a sidebar marked up as a list with h2 titles. This is the convention we recommend for all themes and any theme built in this way can simply register sidebars without worrying about the before/after tags. If, for some compelling reason, 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.
+
* before/after のデフォルト値は、リストを h2 タイトルでマークアップするサイドバーを生成することを想定しています。これは、全てのテーマに推奨される規約で、このように設計されたテーマなら、これらのタグを気にすることなくサイドバーを登録できます。もし、何らかの理由でこのようにマークアップしない場合は、サイドバーを登録するときに、タグを指定する必要があります。id と class 属性はコピーして、内部 sprintf コールが機能するようにし、CSS スタイルが個々のウィジェットに適用できるようにすることを推奨します。
  
== Example ==
+
== 用例 ==
  
This will create a sidebars named "RightSideBar" with &lt;h1&gt; and &lt;/h1&gt; before and after the title:
+
名前が "RightSideBar" で、タイトルの前後が &lt;h1&gt; &lt;/h1&gt; のサイドバーを作成します。
  
 
<pre>
 
<pre>
54行目: 54行目:
 
</pre>
 
</pre>
  
== Changelog ==
+
== 更新履歴 ==
  
* Since: [[Version 2.2|2.2.0]]
+
* [[Version 2.2|2.2.0]] 以降
* [[Version 2.9|2.9.0]] : Added <code>description</code> property
+
* [[Version 2.9|2.9.0]] : <code>description</code> プロパティが追加された
  
== Source File ==
+
== ソースファイル ==
  
<tt>register_sidebar()</tt> is located in {{Trac|wp-includes/widgets.php}}.
+
<tt>register_sidebar()</tt> は、{{Trac|wp-includes/widgets.php}} にあります。
  
 
{{原文|Function Reference/register_sidebar|81535}}<!-- 23:23, 30 December 2009 Ramiy 版 -->
 
{{原文|Function Reference/register_sidebar|81535}}<!-- 23:23, 30 December 2009 Ramiy 版 -->
  
== Related ==
+
== 関連 ==
  
 
{{Widget Tags}}
 
{{Widget Tags}}

2010年4月14日 (水) 21:44時点における版

このページ「関数リファレンス/register sidebar」は未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています

説明

単一サイドバーを定義し、ID を返します。

使い方

<?php register_sidebar( $args ); ?>

デフォルトの使い方

<?php $args = array(
	'name'          => sprintf(__('Sidebar %d'), $i ),
	'id'            => 'sidebar-$i',
	'description'   => ''
	'before_widget' => '<li id="%1$s" class="widget %2$s">',
	'after_widget'  => '</li>',
	'before_title'  => '<h2 class="widgettitle">',
	'after_title'   => '</h2>' ); ?>

(二重引用符の前にバックスラッシュはありません。Codex の PHP ハイライトがおかしいようです。)

パラメータ

$args
文字列/配列) (オプション) 'name' と 'id' 値からサイドバーを作成
初期値: なし
  • name - サイドバー名
  • id - サイドバー id
  • description - サイドバーの説明 (2.9以降)
  • before_widget - ウィジェットの前のテキスト
  • after_widget - ウィジェットの後のテキスト
  • before_title - タイトルの前のテキスト
  • after_title - タイトルの後のテキスト

オプション $args パラメータは連想配列で、アクティブウィジェットコールバックの最初の引数として渡されます。 (配列でなく文字列が渡された場合は、parse_str() を経て連想配列として渡されます。) これらの引数の基本的な使い方は、ウィジェットとタイトルを包む、テーマ固有の HTML タグを渡すことです。

  • register_sidebars() ではなく、この関数を呼び出す必要があるケースは、サイドバーに一意の名前、たとえば “Right Sidebar” や “Left Sidebar” を与えるときや、異なるマークアップが必要なときに限られます。名前は、管理画面でのみ表示されますが、サイドバーの変更を保存するインデックスとしても使用されます。このため、サイドバーに加えた変更は、同じ名前を使用する別テーマを選択した時に、再利用され、上書きされます。
  • before/after のデフォルト値は、リストを h2 タイトルでマークアップするサイドバーを生成することを想定しています。これは、全てのテーマに推奨される規約で、このように設計されたテーマなら、これらのタグを気にすることなくサイドバーを登録できます。もし、何らかの理由でこのようにマークアップしない場合は、サイドバーを登録するときに、タグを指定する必要があります。id と class 属性はコピーして、内部 sprintf コールが機能するようにし、CSS スタイルが個々のウィジェットに適用できるようにすることを推奨します。

用例

名前が "RightSideBar" で、タイトルの前後が <h1> と </h1> のサイドバーを作成します。

register_sidebar(array(
'name' => 'RightSideBar',
'description' => 'Widgets in this area will be shown on the right-hand side.',
'before_title' => '<h1>',
'after_title' => '</h1>'));

更新履歴

  • 2.2.0 以降
  • 2.9.0 : description プロパティが追加された

ソースファイル

register_sidebar() は、wp-includes/widgets.php にあります。

最新英語版: WordPress Codex » Function Reference/register_sidebar最新版との差分

関連

ウィジェット API: is_active_widget(), the_widget(), register_widget(), unregister_widget() / en, wp_register_widget_control() / en, wp_unregister_widget_control() / en, wp_convert_widget_settings() / en, wp_get_widget_defaults() / en, wp_widget_description() / en



関数リファレンステンプレートタグ目次もご覧ください。