CMSimple_XH 開発者ドキュメント
tplfuncs.php ファイル

[ソースコード]

名前空間

 XH
 

関数

 XH_renderPrevLink ()
 
 XH_renderNextLink ()
 
 head ()
 
 sitename ()
 
 pagename ()
 
 onload ()
 
 toc ($start=null, $end=null, $li='li')
 
 li (array $ta, $st)
 
 XH_buildHc ()
 
 searchbox ()
 
 sitemaplink ()
 
 printlink ()
 
 XH_printUrl ()
 
 mailformlink ()
 
 loginlink ()
 
 lastupdate ($br=null, $hour=null)
 
 locator ()
 
 editmenu ()
 
 content ()
 
 submenu ($html='')
 
 previouspage ()
 
 nextpage ()
 
 top ($id='TOP')
 
 languagemenu ()
 
 XH_emergencyTemplate ()
 
 poweredByLink ($linktext='')
 

詳解

Template functions.

tplfuncs.php に定義があります。

関数詳解

◆ content()

content ( )

コンテンツ(管理画面からページ編集で作成した内容)を表示する.(必須

戻り値
string HTML

int The index of the current page. string The output of the contents area. array The content of the pages. bool Whether edit mode is active.

tplfuncs.php464 行目に定義があります。

◆ editmenu()

editmenu ( )

管理画面の編集用メニューの表示. ( 非推奨)

XH 1.5~ 管理メニューとしてテンプレートに自動的に挿入されるので、空の文字列を返します.

戻り値
string HTML
参照
XH_adminMenu()
非推奨:
since 1.7. テンプレートから削除.

tplfuncs.php447 行目に定義があります。

◆ head()

head ( )

HEAD要素(スタイルシート、メタデータ、およびページタイトルのタグ)を返します (必須

戻り値
string HTML

string The page title. array The configuration of the core. array The paths of system files and folders. array The localization of the core. string HTML to be inserted to the HEAD Element.

tplfuncs.php73 行目に定義があります。

◆ languagemenu()

languagemenu ( )

多言語サイトの旗のメニューを返します。
多言語サイト化した際に表示する、言語切り替え用の旗マークを表示。
 多言語化するには、2langフォルダを利用します。
※多言語化しないのであれば、必要ありません

戻り値
string HTML

array The paths of system files and folders. array The configuration of the core. string The current language.

tplfuncs.php597 行目に定義があります。

◆ lastupdate()

lastupdate (   $br = null,
  $hour = null 
)

サイトの最終更新日を返します。

引数
bool$brテキストと日付の間にbr要素を出力するかどうか.
int$hour時間単位での時間補正
戻り値
string HTML

array The localization of the core. array The paths of system files and folders.

tplfuncs.php389 行目に定義があります。

◆ li()

li ( array  $ta,
  $st 
)

特定のページのメニュー構造を返します.

引数
array$taページのインデックス
mixed$stThe menu level to start with or the type of menu.
戻り値
string HTML

使用例

li($c,'menulevel')

tplfuncs.php217 行目に定義があります。

◆ locator()

locator ( )

ロケータ(パンくずリスト)を返します。.

戻り値
string HTML

tplfuncs.php410 行目に定義があります。

◆ loginlink()

loginlink ( )

ログインフォームへのリンクを返します。.

int The index of the requested page. array The localization of the core.

戻り値
string HTML

tplfuncs.php367 行目に定義があります。

◆ mailformlink()

mailformlink ( )

メールフォームへのリンクを返します。
設定 => "CMS設定" => "E-mail form"の下にメールアドレスが入力された場合、連絡先フォームへのリンクを生成します。

戻り値
string HTML

array The configuration of the core.

tplfuncs.php350 行目に定義があります。

◆ nextpage()

nextpage ( )

次のページへ のリンクを返します

戻り値
string HTML

array The localization of the core.

参照
previouspage()

tplfuncs.php559 行目に定義があります。

◆ onload()

onload ( )

body要素のonload属性を返します (必須

戻り値
string HTML

string JavaScript for the onload attribute of the BODY element.

tplfuncs.php138 行目に定義があります。

◆ pagename()

pagename ( )

グローバルサイトのタイトル :$cf['site']['title']  を返します。
Meta_Tagプラグインでの設定が優先します・・
  各ページのMetaタグ設定で、「タイトル代替」が設定されていれば、その「タイトル代替」が優先します。
sitename()も観てください

戻り値
string HTML

array The configuration of the core.

tplfuncs.php123 行目に定義があります。

◆ poweredByLink()

poweredByLink (   $linktext = '')

「Site/CMS Info」ページ へのリンクを作成します。
一般的にフッターに表示される Powered by CMSimple_XH の代替に利用します

One of the 3 functions to create "Site/CMS Info".

引数
string$linktextThe text to be displayed as the link in the template.
戻り値
string The link.

string The site (script) name.

から
1.7

tplfuncs.php671 行目に定義があります。

◆ previouspage()

previouspage ( )

前のページへ のリンクを返します。

戻り値
string HTML

array The localization of the core.

参照
nextpage()

tplfuncs.php540 行目に定義があります。

◆ printlink()

printlink ( )

印刷ビューのリンクを返します

戻り値
string HTML

array The localization of the core.

tplfuncs.php305 行目に定義があります。

◆ searchbox()

searchbox ( )

検索フォームを返します。.

戻り値
string HTML

string The script name. array The localization of the core.

tplfuncs.php272 行目に定義があります。

◆ sitemaplink()

sitemaplink ( )

サイトマップのリンクを返します.

戻り値
string HTML

tplfuncs.php292 行目に定義があります。

◆ sitename()

sitename ( )

ホームページのタイトル、サイト名を返します。
設定 → 言語編集の サイト名:$tx['site']['title'] を返します
※sitename() は、 $tx['site']['title'] がそのまま表示されますが、pagename()は、Meta_Tagプラグインでの設定が優先されます

戻り値
string HTML

array The localization of the core.

tplfuncs.php108 行目に定義があります。

◆ submenu()

submenu (   $html = '')

ページのサブメニューを返します
※Ver1.7よりオプションのパラメータを受け取れます。 これにより、サブメニュータイトルのカスタムマークアップが可能になります

引数
string$htmlOptional markup to wrap the heading.
戻り値
string HTML

int The index of the current page. int The number of pages. array The menu levels of the pages. array The localization of the core. array The configuration of the core.

tplfuncs.php497 行目に定義があります。

◆ toc()

toc (   $start = null,
  $end = null,
  $li = 'li' 
)

目次(メニュー)を返します. (必須)

Table of Contents の略:目次

TOCを作成するコードは、2つの部分に分かれています。関数toc()は表示するページのリストを作成し、このリストで実際の(X)HTMLを出力するli()を呼び出します。CMSimple_XH 1.5.4以降、li()の代わりに使用される独自の関数を記述することができます。 toc()の3番目のパラメータとして追加するだけです。

cmsimple/userfuncs.php に my_li 関数を作成し

<?php echo toc(null, null, 'my_li');?>

 

引数
int$start 表示するメニューのレベルの始め
int$endThe menu level to end with.
callable$liA callback that actually creates the view.
戻り値
string HTML

int The number of pages. int The index of the current page. array The menu levels of the pages. array The configuration of the core.

tplfuncs.php160 行目に定義があります。

◆ top()

top (   $id = 'TOP')

「ページの上部へ」 のリンクを返します

適切なIDをテンプレートに定義する必要があります。

引数
string$idAn (X)HTML ID.
戻り値
string HTML

array The localization of the core.

tplfuncs.php580 行目に定義があります。

◆ XH_buildHc()

XH_buildHc ( )

メニュー用のグローバル変数・・ $hc$hl$si を設定している

$hc メニューインデックスの配列で、最も重要な変数となります。 これは通常、最初の引数として li() に渡されます。例えば li ($hc) です。
$hl は、$hcの要素の個数・・メニューに掲載する総ページ数・・を保持します。
$si は、 $hc 内のメニューのインデックスを保持します。

テンプレートの作成時に使用することは、ありません。・・高度なメニューには便利かもしれません

戻り値
void

global $cl, $s, $cf, $si, $hc, $hl
int The number of pages.
int The current page index.
array The configuration of the core.
int The index of the current page in $hc.
array The page indexes of the visible menu items.
int The length of $hc.

から
1.6.2

tplfuncs.php243 行目に定義があります。

◆ XH_emergencyTemplate()

XH_emergencyTemplate ( )

テンプレートが見つからない場合に、最小のテンプレートを提供します

テンプレートの作成に通常は使用することは、ありません

戻り値
void
から
1.6.3

tplfuncs.php641 行目に定義があります。

◆ XH_printUrl()

XH_printUrl ( )

印刷ビューのURLを返します

テンプレートの作成に通常は使用することは、ありません

戻り値
string

string The requested special function. string The current search string. string The requested special file. string The script name.

から
1.6

tplfuncs.php325 行目に定義があります。

◆ XH_renderNextLink()

XH_renderNextLink ( )

Renders the next link.

テンプレートの作成に通常は使用することは、ありません。 nextpage() で使用されます。

戻り値
string HTML

string The script name. array The page URLs.

から
1.6.3

tplfuncs.php50 行目に定義があります。

◆ XH_renderPrevLink()

XH_renderPrevLink ( )

Renders the prev link.

テンプレートの作成に通常は使用することは、ありません。  previouspage() で使用されます。

戻り値
string HTML

string The script name. array The page URLs.

から
1.6.3

tplfuncs.php28 行目に定義があります。