Please Sign In or Register

ホーム » Drupal 6.x テーマ作成ガイド » D.I.Y. kit 6.x テーマの基本構造 » diykit/page.tpl.php

diykit/page.tpl.php

D.I.Y. kit テーマの diykit/page.tpl.php テンプレートファイル内で使用可能なデフォルトのテーマ変数と、D.I.Y. kit 独自のテーマ変数についてまとめています。

diykit/page.tpl.php 内で使用可能なテーマ変数

デフォルトのテーマ変数は includes/theme.inc 内などで定義され、D.I.Y. kit 独自のテーマ変数は diykit/template.php 内で定義しています。
D.I.Y. kit 独自のテーマ変数や、デフォルトのテーマ変数に変更を加えた箇所に * マークを追加しています。

全般的なユーティリティ変数
$base_path ベースとなる URL を内部パスで返します。 通常 "/" が返されます。
$css 現在のページの CSS ファイルを配列で返します。
$directory "sites/all/themes/diykit" のような D.I.Y. kit テーマまでのパスを返します。
$is_front 表示しているページがフロントページである場合、"TRUE" を返します。
$logged_in 閲覧しているユーザがログインユーザである場合、"TRUE" を返します。
$is_admin 閲覧しているユーザがサイトの管理者である場合、"TRUE" を返します。
XML 宣言の出力を行うための変数
$xml * ユーザエージェントが "Windows 版 IE6" 以外の場合に XML 宣言を返します。*
ページのメタデータとして使用される変数
$language 言語情報を "language" オブジェクトとして返します。
$language->language <html> タグの lang 属性の値などに使用される "ja" のような言語コードを返します。
$language->dir <html> タグの dir 属性の値として使用される "ltr" または "rtl" の文字方向を返します。
$head_title "コンテンツタイトル | サイト名" のような、通常、<title> タグ内で使用される文字列を返します。
$head <meta> タグや <link> タグなどにセットされた内容があれば、その内容を返します。
CSS およびスクリプトに関連する変数
$styles <style> タグにセットされた内容があれば、その内容を返します。
テーマで使用される CSS は、diykit/style.css, diykit/skin/skin-name/skin.css, diykit/common.css の順に読み込まれます。*
$iefix * ユーザエージェントが IE の場合にのみ読み込むための条件付きコメントを利用した <style> タグを返します。*
IE を対象とした CSS は、diykit/ie-fix.css, diykit/skin/skin-name/ie-fix.css の順に読み込まれます。*
$scripts <script> タグにセットされた内容があれば、その内容を返します。
$body_classes 以下の内容を半角スペース（" "）で区切って返します。
  • 表示しているページがフロントページであれば "front"、そうでなければ "not-front"
  • 閲覧しているユーザがログインユーザであれば "logged-in" そうでなければ "not-logged-in"
  • 表示しているページのアーギュメントに応じて "page-arg(0)"
  • 表示しているページのコンテンツタイプに応じて "node-type-type"
  • サイドバーの有無に応じて "no-sidebars", "one-sidebar sidebar-left", "one-sidebar sidebar-right", "two-sidebars" のいずれか
  • テーマ設定で選択したページレイアウトのタイプに応じて "fixed", "liquid", "flexible" *
  • テーマ設定で選択したカラムレイアウトのタイプに応じて "portal", "news" *
ページの情報を表す変数
$front_page フロントページの URL を内部パスで返します。
$logo ロゴのパスを返します。 <img> タグなどは含みません。
$site_name サイト名を返します。
$site_slogan スローガンの内容が入力されていれば、その内容を返します。
$mission ミッションの内容が入力されていれば、その内容を返します。
ページのナビゲーションに使用される変数
$search_box 検索ボックスの表示が有効になっている場合に、検索ボックスの内容を返します。
$primary_links プライマリリンクが設定されている場合、その内容を配列として返します。
$secondary_links セカンダリリンクが設定されている場合、その内容を配列として返します。
ページのコンテンツに使用される変数
$header ヘッダに表示するブロックが設定されていれば、そのブロックの内容を返します。
$footer フッタに表示するブロックが設定されていれば、そのブロックの内容を返します。
$left 左サイドバーに表示するブロックが設定されていれば、そのブロックの内容を返します。
$right 右サイドバーに表示するブロックが設定されていれば、そのブロックの内容を返します。
$node_top * ノード上部に表示するブロックが設定されていれば、そのブロックの内容を返します。*
$node_bottom * ノード下部に表示するブロックが設定されていれば、そのブロックの内容を返します。*
$node_body_top * ノード本文の上部に表示するブロックが設定されていれば、そのブロックの内容を返します。*
D.I.Y. kit では、diykit/page.tpl.php ではなく diykit/node.tpl.php で使用しています。
$node_body_bottom * ノード本文の下部に表示するブロックが設定されていれば、そのブロックの内容を返します。*
D.I.Y. kit では、diykit/page.tpl.php ではなく diykit/node.tpl.php で使用しています。
$breadcrumb パンくずリストとして取得できる内容があれば、その内容を返します。
セパレータ記号はプレーンテキストではなく <span> タグで括られた形式で返されます。*
$title コンテンツの単一ページに表示される <a> タグを含まないタイトルを返します。
ティーザーリストなどで使用される <a> タグを含むタイトルは、diykit/node.tpl.php で指定します。
$help ヘルプテキストを返します。
ヘルプテキストは、管理セクションなどで表示される、設定内容などに関する説明です。
$messages システムメッセージを返します。
返されたメッセージには、種類に応じた class が割り当てられています。
$tabs コンテンツの「表示」「編集」タブや、管理セクションで表示されるタブの内容などを返します。
$content コンテンツ（diykit/node.tpl.php）や管理セクションでの内容を返します。
フッタおよびページの終了部分で使用される変数
$feed_icons フィードアイコンとフィードページへのリンクを返します。
フィードアイコンは、diykit/skin/skin-name/images/feed.png, diykit/images/feed.png, デフォルトのフィードアイコンの順で適用されます。*
$footer_message フッタメッセージの内容が入力されていれば、その内容を返します。
$closure JavaScript のコードなどセットされた内容があれば、その内容を返します。
通常は </body> タグの直前にセットします。
[参考]
page.tpl.php テンプレートファイル | DRUPAL*DRUPAL

DRUPAL*DRUPAL ドキュメントについて

  • DRUPAL*DRUPAL ドキュメントは、公式サイトのドキュメントである Drupal handbooks およびその他の関連ページの内容を参考にして作成しています。（参考サイトは各ページに記載）
  • DRUPAL*DRUPAL ドキュメントの各コンテンツは、クリエイティブ・コモンズ・ライセンス の下でライセンスされています。 また、コンテンツ内の各コードは、GNU GPL v2.0 の下でライセンスされています。
  • Drupal handbooks の各ページの著作権は、それぞれの Book contributors に帰属します。

Creative Commons License

^ Page Top
The D.I.Y. theme kit for Drupal 6.x by DRUPAL*DRUPAL.