リファレンス

目次

ビルトインモジュール

ビルトインモジュールは、テンプレート上にモジュールを読み込んで使用します。管理ページで詳細を設定することができます。

エントリー

エントリー本文
Entry_Body 		エントリーの一覧表示、単一表示、エントリーの投稿 変数表 スニペット
エントリーリスト
Entry_List 		エントリーの一覧(URLとタイトル)を表示 変数表 スニペット
フォト
Entry_Photo 		エントリー中の画像を一覧表示 変数表 スニペット
ヘッドライン
Entry_Headline 		エントリーの一覧(URLとタイトルと日時とカテゴリー)を表示 変数表 スニペット
サマリー
Entry_Summary 		エントリーの一覧(URLとタイトルと日時とカテゴリーとメイン画像と概要テキストとVer.2.6より関連エントリー)を表示 変数表 スニペット
エントリー位置リスト
Entry_GeoList 		位置情報に基づいて、近い距離順でエントリーの一覧を表示 変数表 スニペット
アーカイブ
Entry_ArchiveList 		エントリーの年月別アーカイブのURLと件数を表示 ( ※ver1.1.0で追加 ) 変数表 スニペット
タグリレーショナル
Entry_TagRelational 		同じタグがつけられたエントリーの一覧(URLとタイトルと日時とカテゴリーとメイン画像と概要テキスト)を表示 変数表 スニペット
エントリーカレンダー
Entry_Calendar 		エントリーをカレンダー状にレイアウトして表示( ※ver1.5.0で追加 ) 変数表 スニペット
エントリーフィールド
Entry_Field 		フィールドモジュールを確認

カテゴリー

カテゴリーリスト
Category_List 		カテゴリーの一覧を表示 変数表 スニペット
カテゴリー位置リスト
Category_GeoList 		カテゴリーの一覧とその位置情報を表示 変数表 スニペット
カテゴリーエントリーリスト
Category_EntryList 		カテゴリーと、そのエントリーの一覧を表示 変数表 スニペット
カテゴリーエントリーサマリー
Category_EntrySummary 		カテゴリーと、そのエントリーの一覧(URLとタイトルと日時とカテゴリーとメイン画像と概要テキスト)を表示( ※ver1.5.0で追加 ) 変数表 スニペット
カテゴリーフィールド
Category_Field 		フィールドモジュールを確認

サイトパーツ

リンク集
Links 		設定したリンク(ラベルとURL)を表示 変数表 スニペット
バナー
Banner 		バナーを表示(画像ファイル or HTML記述の選択式) 変数表 スニペット
メディアバナー
Media_Banner 		バナーを表示(メディア or HTML記述の選択式) 変数表 スニペット
ナビゲーション
Navigation 		設定したナビゲーション(ラベルとURL、属性、階層関係)を表示 変数表 スニペット
トピックパス
Topicpath 		パンくずリストを表示 変数表 スニペット

コメント

コメント本文
Comment_Body 		コメントの一覧を表示とコメントの投稿 変数表 スニペット
コメントリスト
Comment_List 		コメントの一覧を簡易表示 変数表 スニペット

タグ

タグクラウド
Tag_Cloud 		タグの一覧を表示 変数表 スニペット
タグフィルター
Tag_Filter 		タグの絞り込みを表示 変数表 スニペット

API

Google Analyticsランキング
Api_GoogleAnalytics_Ranking 		Google Analytics で取得したアクセス数に基づいてページをランキング形式で表示する（Ver.2.6.1より追加） 変数表 スニペット
Twitterホームタイムライン
Api_Twitter_Statuses_HomeTimeline 		ブログに紐づけられたTwitterユーザーのメインタイムラインを表示する スニペット
Twitterユーザータイムライン
Api_Twitter_Statuses_UserTimeline 		指定されたTwitterユーザーのメインタイムラインを表示する スニペット
Twitterリストメンバーズ
Api_Twitter_List_Members 		指定されたTwitterリストに含まれるTwitterユーザーを表示する スニペット
Twitterリストタイムライン
Api_Twitter_List_Statuses 		指定されたTwitterリストのタイムラインを表示する スニペット
Twitterサーチ
Api_Twitter_Search 		指定キーワードによる検索結果のタイムラインを表示する スニペット
Instagramいいね！
Api_Instagram_Users_Media_Liked 		ブログに紐付けられたInstagramユーザーが"いいね!"した写真を順に表示します。 スニペット
Instagram最新投稿
Api_Instagram_Users_Media_Recent 		ブログに紐付けられたInstagramユーザーの写真を新しい順に表示します。 スニペット
Bingウェブ検索
Api_Bing_WebSearch 		変数表 スニペット
Bingイメージ検索
Api_Bing_ImageSearch 		変数表 スニペット

その他

ユニットリスト
Unit_List 		ユニット(エントリーの1ブロックの単位)をリスト表示 変数表 スニペット
OGP
Ogp 		OGP周りの変数を表示 変数表 スニペット
カレンダー
Calendar_Month 		カレンダーを表示 変数表 スニペット
年間カレンダー
Calendar_Year 		カレンダーを年別表示 変数表 スニペット
スケジュール
Schedule 		日付毎の簡易情報を登録して表示する 変数表 スニペット
ユーザープロフィール
User_Profile 		ユーザーのプロフィールを表示 変数表 スニペット
ユーザーサーチ
User_Search 		ブログに登録されているユーザーを表示する 変数表 スニペット
ユーザー位置リスト
User_GeoList 		ユーザーの一覧と位置情報を表示する 変数表 スニペット
子ブログリスト
Blog_ChildList 		子ブログをリスト表示する 変数表 スニペット
ブログ位置リスト
Blog_GeoList 		子ブログの一覧とその位置情報を表示する 変数表 スニペット
カートリスト
Shop_Cart_List 		カートの中に入れたアイテム（商品エントリー）の情報を表示する 変数表 スニペット
カートノーティファイ
Shop_Cart_Notify 		直前にカートの中に入れたアイテム（商品エントリー）をの情報を簡易表示する 変数表 スニペット
エイリアスリスト
Alias_List 		エイリアスをリスト表示する 変数表 スニペット
フィールドバリューリスト
Field_ValueList 		指定されたフィールドのキーで登録されている値を列挙して表示する 変数表 スニペット
RSS2
Feed_Rss2 		RSS2を出力 変数表 スニペット
外部フィードリスト
Feed_ExList 		外部サイトのフィードを読み込んで表示 変数表 スニペット
ケースビュー
Case_View 		ページの表示状態による条件分岐 変数表 スニペット
ケースオース
Case_Auth 		ログイン中ユーザーの権限による条件分岐 変数表 スニペット

フィールドモジュール

フィールドモジュールは、見ているページの標準のフィールドとカスタムフィールドの情報を変数として扱えます。次の例では、カテゴリーごとに紐付けされたカスタムフィールドの画像(headimage)を表示します。紐付けされた画像情報がなければ、:veilによって表示されなくなります。

例：カテゴリーのカスタムフィールドを表示する

<!-- BEGIN_MODULE Category_Field -->
　<!-- BEGIN headimage:veil -->
　　<img src="{headimage@path}" width="" height="" />
　<!-- END headimage:veil -->
<!-- END_MODULE Category_Field -->
Blog_Field 表示中のページが帰属するブログのフィールド情報を出力 変数表 ソース 
例）<!-- BEGIN_MODULE Blog_Field -->
<!-- END_MODULE Blog_Field -->
Category_Field 表示中のページが帰属するカテゴリーのフィールド情報を出力 変数表 ソース 
例）<!-- BEGIN_MODULE Category_Field -->
<!-- END_MODULE Category_Field -->
Entry_Field 表示中のページが帰属する記事のフィールド情報を出力 変数表 ソース 
例）<!-- BEGIN_MODULE Entry_Field -->
<!-- END_MODULE Entry_Field -->
User_Field 表示中のページが帰属するユーザーのフィールド情報を出力 変数表 ソース 
例）<!-- BEGIN_MODULE User_Field -->
<!-- END_MODULE User_Field -->
Module_Field モジュールIDのフィールド情報を出力（Ver.2.6.1より追加） ソース 
例）<!-- BEGIN_MODULE Module_Field -->
<!-- END_MODULE Module_Field -->

タッチモジュール

タッチモジュールは、見ているページ(テンプレート)がその条件にあてはまる時だけ表示されます。次の例では、単一記事の表示のときだけコメントモジュールを読み込みます。

例：エントリーが指定されている（個別ページ）時のみコメントモジュールを表示する

<!-- BEGIN_MODULE Touch_Entry -->
　<!-- BEGIN_MODULE Comment_Body -->
　　（中略）
　<!-- END_MODULE Comment_Body -->
<!-- END_MODULE Touch_Entry -->

タッチモジュール

Touch_Top 「トップページ」の時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_Top -->
<!-- END_MODULE Touch_Top -->
Touch_Index 「一覧ページ」の時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_Index -->
<!-- END_MODULE Touch_Index -->
Touch_Entry 「エントリー」が指定されている時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_Entry -->
<!-- END_MODULE Touch_Entry -->
Touch_Category 「カテゴリー」が指定されている時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_Category -->
<!-- END_MODULE Touch_Category -->
Touch_Keyword 「キーワード」が指定されている時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_Keyword -->
<!-- END_MODULE Touch_Keyword -->
Touch_Tag 「タグ」が指定されている時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_Tag -->
<!-- END_MODULE Touch_Tag -->
Touch_User 「ユーザー」が指定されている時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_User -->
<!-- END_MODULE Touch_User -->
Touch_SearchEngineKeyword 「検索エンジンのキーワード」を取得できている時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_SearchEngineKeyword -->
<!-- END_MODULE Touch_SearchEngineKeyword -->
Touch_RootBlog ルートブログの時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_RootBlog -->
<!-- END_MODULE Touch_RootBlog -->
Touch_BlogGlobal ログインしたブログ自身に子ブログを持っている時のみ、そのブログと子ブログに表示する（※ログイン状態のみ適用） ソース 
<!-- BEGIN_MODULE Touch_BlogGlobal -->
<!-- END_MODULE Touch_BlogGlobal -->
Touch_Admin 「管理状態（エントリー編集など）」の時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_Admin -->
<!-- END_MODULE Touch_Admin -->
Touch_SessionWithAdministration 「管理者」の時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_SessionWithAdministration -->
<!-- END_MODULE Touch_SessionWithAdministration -->
Touch_SessionWithCompilation 「編集者」以上の時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_SessionWithCompilation -->
<!-- END_MODULE Touch_SessionWithCompilation -->
Touch_SessionWithContribution 「投稿者」以上の時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_SessionWithContribution -->
<!-- END_MODULE Touch_SessionWithContribution -->
Touch_SessionWithSubscription 「読者」以上の時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_SessionWithSubscription -->
<!-- END_MODULE Touch_SessionWithSubscription -->
Touch_SessionIsCompilation 「編集者」の時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_SessionIsCompilation -->
<!-- END_MODULE Touch_SessionIsCompilation -->
Touch_SessionIsContribution 「投稿者」の時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_SessionIsContribution -->
<!-- END_MODULE Touch_SessionIsContribution -->
Touch_SessionIsSubscription 「読者」の時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_SessionIsSubscription -->
<!-- END_MODULE Touch_SessionIsSubscription -->
Touch_Login 「ログイン状態」の時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_Login -->
<!-- END_MODULE Touch_Login -->
Touch_Unlogin 「非ログイン状態」の時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_Unlogin -->
<!-- END_MODULE Touch_Unlogin -->
Touch_Edit 「エントリー編集（作成・変更・追加）」の時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_Edit -->
<!-- END_MODULE Touch_Edit -->
Touch_EditInplace ダイレクト編集が有効な時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_EditInplace -->
<!-- END_MODULE Touch_EditInplace -->
Touch_EditInsert 「エントリー編集（作成）」の時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_EditInsert -->
<!-- END_MODULE Touch_EditInsert -->
Touch_EditUpdate 「エントリー編集（変更・追加）」の時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_EditUpdate -->
<!-- END_MODULE Touch_EditUpdate -->
Touch_BlogParent 現在見ているブログ自身が子ブログを持っている時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_BlogParent -->
<!-- END_MODULE Touch_BlogParent -->
Touch_Ssl 現在見ているページがHTTPSで通信されている時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_Ssl -->
<!-- END_MODULE Touch_Ssl -->
Touch_SslEnable config.server.php内でSSL_ENABLEが1に設定されている時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_SslEnable -->
<!-- END_MODULE Touch_SslEnable -->
Touch_Debug config.server.php内でDEBUG_MODEが1に設定されている時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_Debug -->
<!-- END_MODULE Touch_Debug -->

Not系タッチモジュール

Touch_NotTop トップページ」ではない時に表示する ソース 
<!-- BEGIN_MODULE Touch_NotTop -->
<!-- END_MODULE Touch_NotTop -->
Touch_NotIndex 「一覧ページ」ではない時に表示する ソース 
<!-- BEGIN_MODULE Touch_NotIndex -->
<!-- END_MODULE Touch_NotIndex -->
Touch_NotEntry 「エントリー」が指定されていない時に表示する ソース 
<!-- BEGIN_MODULE Touch_NotEntry -->
<!-- END_MODULE Touch_NotEntry -->
Touch_NotCategory 「カテゴリー」が指定されていない時に表示する ソース 
<!-- BEGIN_MODULE Touch_NotCategory -->
<!-- END_MODULE Touch_NotCategory -->
Touch_NotAdmin 「管理ページ（エントリー編集など）」ではない時に表示する ソース 
<!-- BEGIN_MODULE Touch_NotAdmin -->
<!-- END_MODULE Touch_NotAdmin -->
Touch_NotTag 「タグ」が指定されていない時に表示する ソース 
<!-- BEGIN_MODULE Touch_NotTag -->
<!-- END_MODULE Touch_NotTag -->
Touch_NotKeyword 「キーワード」が指定されていない時に表示する ソース 
<!-- BEGIN_MODULE Touch_NotKeyword -->
<!-- END_MODULE Touch_NotKeyword -->
Touch_NotSearchEngineKeyword 「検索エンジンのキーワード」を取得できていない時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_NotSearchEngineKeyword -->
<!-- END_MODULE Touch_NotSearchEngineKeyword -->
Touch_NotEdit エントリー編集（作成・変更・追加）」ではない時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_NotEdit -->
<!-- END_MODULE Touch_NotEdit -->
Touch_NotEditInplace ダイレクト編集が有効でない時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_NotEditInplace -->
<!-- END_MODULE Touch_NotEditInplace -->
Touch_NotRootBlog ルートブログでない時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_NotRootBlog -->
<!-- END_MODULE Touch_NotRootBlog -->
Touch_NotBlogParent 現在見ているブログ自身が子ブログを持っていない時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_NotBlogParent -->
<!-- END_MODULE Touch_NotBlogParent -->
Touch_NotDebug config.server.php内でDEBUG_MODEが1に設定されていない時のみ表示する ソース 
<!-- BEGIN_MODULE Touch_NotDebug -->
<!-- END_MODULE Touch_NotDebug -->

Facebook系タッチモジュール

Facebook系タッチモジュールを利用するには、プロパティ設定からApp IDとSecretの指定が必要です。

Api_Facebook_Touch_Signed Facebookページのiframe内から呼び出されている、正規リクエストの時のみ表示する ソース 
<!-- BEGIN_MODULE Api_Facebook_Touch_Signed -->
<!-- END_MODULE Api_Facebook_Touch_Signed -->
Api_Facebook_Touch_NotSigned Facebookページのiframe内から呼び出されていない、非正規リクエストの時のみ表示する ソース 
<!-- BEGIN_MODULE Api_Facebook_Touch_NotSigned -->
<!-- END_MODULE Api_Facebook_Touch_NotSigned -->
Api_Facebook_Touch_Like 表示元のFacebookページを、ユーザーがイイネしている時のみ表示する。非正規リクエストであれば表示しない
※ 2014年11月5日よりFacebookの仕様変更により正常に動作しなくなっております 		ソース 
<!-- BEGIN_MODULE Api_Facebook_Touch_Like -->
<!-- END_MODULE Api_Facebook_Touch_Like -->
Api_Facebook_Touch_NotLike 表示元のFacebookページを、ユーザーがイイネしていない時のみ表示する。非正規リクエストであれば表示しない
※ 2014年11月5日よりFacebookの仕様変更により正常に動作しなくなっております 		ソース 
<!-- BEGIN_MODULE Api_Facebook_Touch_NotLike -->
<!-- END_MODULE Api_Facebook_Touch_NotLike -->
Api_Facebook_Touch_Admin ユーザーが、表示元のFacebookページの管理者である時のみ表示する 。非正規リクエストであれば表示しない ソース 
<!-- BEGIN_MODULE Api_Facebook_Touch_Admin -->
<!-- END_MODULE Api_Facebook_Touch_Admin -->
Api_Facebook_Touch_NotAdmin ユーザーが、表示元のFacebookページの管理者である時のみ表示する 。非正規リクエストであれば表示しない ソース 
<!-- BEGIN_MODULE Api_Facebook_Touch_NotAdmin -->
<!-- END_MODULE Api_Facebook_Touch_NotAdmin -->

グローバル変数

グローバル変数は、テンプレートに記述することで、表示中のページが持つ情報を出力します。テンプレート上、モジュールやインクルードよりも先に処理されます。

ID（数字）の出力

%{RBID} ルートブログID
%{PBID} 親ブログID
%{BID} ブログID
%{RCID} ルートカテゴリーID
%{PCID} 親カテゴリーID
%{CID} カテゴリーID
%{EID} エントリーID
%{UID} ユーザーID
%{ALIAS_ID} エイリアスID
%{RVID} バージョンID
%{UTID} ユニットID
%{CMID} コメントID
%{SESSION_USER_ID} ログイン中のユーザーID
%{SESSION_BLOG_ID} ログイン中のブログID
%{MID} (ver2501〜) モジュール編集画面のモジュールID
%{CONFIG_SET_ID} (ver2.10.0〜) コンフィグセットのID

コードの出力

%{RBCD} ルートブログコード
%{PBCD} 親ブログコード
%{BCD} ブログコード
%{RCCD} ルートカテゴリーコード
%{PCCD} 親カテゴリーコード
%{CCD} カテゴリーコード
%{ECD} エントリーコード
%{UCD} ユーザーコード
%{ALIAS_CODE} エイリアスコード
%{SESSION_USER_CODE} ログイン中のユーザーコード
%{MODULE_ID} (ver2501〜) モジュール編集画面でのid

名前の出力

%{ROOT_BLOG_NAME} 表示ページが属するルートブログの名前
%{PARENT_BLOG_NAME} 表示ページが属する親ブログの名前
%{BLOG_NAME} 表示ページが属するブログの名前
%{ROOT_CATEGORY_NAME} 表示ページが属するルートカテゴリーの名前
%{PARENT_CATEGORY_NAME} 表示ページが属する親カテゴリーの名前
%{CATEGORY_NAME} 表示ページが属するカテゴリーの名前
%{ENTRY_TITLE} 表示ページが属するエントリーの名前
%{USER_NAME} ユーザーの名前
%{ALIAS_NAME} エイリアスの名前
%{SESSION_USER_NAME} ログイン中のユーザーの名前
%{MODULE_NAME} (Ver. 2.5.1〜) モジュール編集画面でのモジュール名
%{CONFIG_SET_NAME} (Ver. 2.10.0〜) コンフィグセットの名前

URLコンテキストの出力

%{KEYWORD} URLコンテキスト上で、指定されたキーワード
%{FIELD} URLコンテキスト上で、指定されたフィールド
%{TAG} URLコンテキスト上で、指定されたタグ
%{PAGE} URLコンテキスト上で、指定されたページ番号
%{DATE} URLコンテキスト上で、指定された日付
%{DATE_YEAR} URLコンテキスト上で、指定された年
%{DATE_MONTH} URLコンテキスト上で、指定された月
%{DATE_DAY} URLコンテキスト上で、指定された日
%{START} URLコンテキスト上で、指定された日付（始め）
%{END} URLコンテキスト上で、指定された日付（終わり）
%{ORDER} URLコンテキスト上で、指定された並び順
%{QUERY} URLコンテキスト上で、指定されたクエリストリング
%{QOL} URLコンテキスト上で、指定されたクエリストリング
%{ADMIN} URLコンテキスト上で、指定された管理ページ
%{ADMIN_PATH} URLコンテキスト上で、指定された管理ページパス

URL・パスの出力

%{HOME_URL} ルートブログのトップページのURL
%{ROOT_BLOG_URL} ルートブログのトップページのURL
%{PARENT_BLOG_URL} 親ブログのトップページのURL
%{BLOG_URL} ブログのトップページのURL
%{ROOT_CATEGORY_URL} ルートカテゴリーページのURL
%{PARENT_CATEGORY_URL} 親カテゴリーページのURL
%{CATEGORY_URL} カテゴリーページのURL
%{BASE_URL} 基本となるURL
%{HTTP_ROOT} URLで表されるルートディレクトリ
%{INHERLINK} 現在のURLコンテキストを考慮したURL
%{CURRENT_URL} 表示中のURL
%{PERMALINK} 表示中ページへのパーマリンク
%{ROOT_DIR} ドキュメントルートからindex.phpのある場所までのパス
%{IMAGES_DIR} システムが使用する画像のあるディレクトリ( /images )のパス
%{ARCHIVES_DIR} アーカイブディレクトリ( /archives )のパス
%{BID_ARCHIVES_DIR} ブログを考慮したアーカイブディレクトリ( /archives/001 )のパス
%{YM_ARCHIVES_DIR} ブログの日付を考慮したアーカイブディレクトリ( /archives/001/201801 )のパス
%{HTTP_ARCHIVES_DIR} アーカイブディレクトリ( http://example.com/archives )のURL
%{HTTP_THEMES_DIR} テーマディレクトリ( http://example.com/themes )のURL
%{HTTP_CURRENT_THEMES_DIR} 現在表示されているページのテーマパス( http://example.com/themes/site )のURL
%{HTTP_BID_ARCHIVES_DIR} ブログの日付を考慮したアーカイブディレクトリ( http://example.com/archives/001/201801 )のURL
%{HTTP_YM_ARCHIVES_DIR} ブログの日付を考慮したアーカイブディレクトリ( http://example.com/archives/001/201801 )のURL
%{MEDIA_ARCHIVES_DIR} メディアアーカイブディレクトリ( /media )のパス
%{HTTP_MEDIA_ARCHIVES_DIR} ブログの日付を考慮したアーカイブディレクトリ( http://example.com/media )のURL
%{THEMES_DIR} テーマディレクトリ ( /themes )のパス
%{SYSTEM_THEMES_DIR} システムテーマディレクトリ ( /themes/system )のパス
%{CURRENT_THEMES_DIR} 現在表示されているページのテーマディレクトリ
%{SCRIPT_ROOT} システムのメインスクリプトのパス
%{ALIAS_DOMAIN} エイリアスのドメイン
%{BASE_ACMS_PATH} 基本となるacmsパス
%{REQUEST_PATH} 表示URL中の、a-blog cms設置ディレクトリ以降のパス
%{REQUEST_DIRNAME} 表示URL中の、a-blog cms設置ディレクトリ以降のURL

コンフィグの出力

%{META_KEYWORDS} コンフィグで指定したメタ情報のキーワード
%{META_DESCRIPTION} コンフィグで指定したメタ情報のディスクリプション
%{SYSTEM_MAIL} コンフィグで指定したシステムが使用するメールアドレス
%{CHARSET} コンフィグで指定した出力文字コード
%{BLOG_THEME_COLOR} コンフィグで指定したブログのテーマカラー
%{MAIL_SUBSCRIBE_ADMIN_FROM} コンフィグで指定した管理者宛読者登録通知メールの送信元メールアドレス
%{MAIL_SUBSCRIBE_FROM} コンフィグで指定した読者登録通知メールの送信元メールアドレス
%{MAIL_REMIND_FROM} コンフィグで指定したパスワード再発行通知メールの送信元メールアドレス
%{MAIL_COMMENT_FROM} コンフィグで指定したコメント通知メールの送信元メールアドレス
%{MAIL_MAGAZINE_FROM} コンフィグで指定したメールマガジンの送信元メールアドレス.phpのある場所までのパス
%{PHP_FILE_MAX_SIZE} アップロード最大サイズ（upload_max_filesize）
%{PHP_POST_MAX_SIZE} ポスト最大サイズ（post_max_size）

日付・時間の出力

%{NOW_DATE} 表示した時点の日付
%{NOW_TIME} 表示した時点の時間
%{Y}, %{m}, %{d}... phpのdate関数に指定出来る日付文字列の書式

その他

%{DOMAIN} 表示しているブログのドメイン名
%{SNAME} 動作中のa-blog cmsのセッション名
%{CATEGORY_EXISTS} 表示中のブログにカテゴリーが存在するか判定
%{CATEGORY_LEVEL} 現在いるカテゴリー階層
%{SEARCH_ENGINE_KEYWORD} 検索エンジンからのトラフィックだった場合のリファラーに含まれる検索キーワード（キャッシュ無効時のみ使用可）
%{UA} クライアントのユーザーエージェント情報
%{UA_GROUP} クライアントのユーザーエージェントの所属グループ情報
%{ROOT_TPL} 現在表示中のルートテンプレート
%{REMOTE_ADDR} 接続元リモートアドレス情報
%{PROTOCOL} プロトコル（http : https）
%{VIEW} ページの表示状態（トップ・一覧・詳細）を示す文字列（top, index, entry）を出力する
%{SESSION_USER_AUTH} ログイン中のユーザーの権限を示す文字列（administrator, editor, contributor, subscriber）を出力する
%{SESSION_USER_MAIL} ログイン中のユーザーのメールアドレス
%{IS_ADMIN} 管理画面を表示の際にに 1 を出力する

校正オプション

{var}[option]というように、変数の後に[]を記述して校正オプションを使用します。また、オプションはパイプ ( | ) を使用して複数指定することもできます。

Ver. 2.10 以下のバージョンの場合に注意

校正オプションを何か一つ設定すると escapeが自動で指定されません。（Ver. 2.10 以下） エスケープが必要な場合は 必ずescapeをパイプで繋げて下さい。 校正オプションが何も指定されない場合には、デフォルトでescapeが指定されます。
例) {var}[escape|nl2br]

日付の校正

wareki 日付から和暦の年を算出して表示します。
※{date}の中は、YYYY-mm-ddの書式の日付情報（例では1985-08-26）とします
例1：{date}[wareki] → 昭和60
例2：{date}[wareki('年m月d日')] → 昭和60年8月26日
age 日付を誕生日としたときの現在の年齢を表示します。
例) 1985/08/26[age] -> 23
date 日付を指定した形式で表示します。(PHP:date関数準拠)
半角英数をつなぎ文字に入れる際は、エスケープが必要です。
例1：1985/08/26[date('Y年n月d日')] -> 1985年8月26日
例2：1985/08/26[date('M d\t\h, Y')] -> Aug 26th, 1985
weekEN2JP 英字の週（Sunday, Monday...）を日本語に変換します。
日本語名はconfig.system.default.yamlの「week_label」を参照。
例1：{date#l}[weekEN2JP] -> 日

標準の校正

escape <, >, "といった文字を実体参照に変換します。
escvars ブレース（{, }）を実体参照に変換します。
escquot ダブルクオーテーション（"）をエスケープ（""）します。
nl2br 改行を<br />に変換します。
nl2br4html 改行を<br>に変換します。＊php5.3以上でないと動きません
delnl 改行コードを削除する。
list 行を<li>で囲みます。
definition_list 行を<dt>、<dd>で囲みます。行頭に#を付けると<dt>になります。
table 行を<tr>で囲み、さらにカンマを<td>で囲みます。 書き方は、エントリーのテーブル書式と同じです。
markdown マークダウン記法を使用します。
引数を指定して見出しレベルを調節することができます。
例：{text}[markdown(1)]
trim 文字幅を指定して足切りします。
例：{text}[trim(13, '...')]
mb_trim 指定した文字数（マルチバイト対応）で足切りします。
例：{text}[mb_trim(13, '...')]
raw 校正せず、そのままのデータを出力します。
※校正オプションが何も指定されない場合には、デフォルトでescapeが指定されます。
number_format 数字を千位毎にカンマ区切りにします。
convert_bytes バイト数を（K: キロ, M: メガ, G: ギガ）の単位に変換します。
{pdf@fileSize}[convert_bytes('k', 0)] → KB単位で表示
{pdf@fileSize}[convert_bytes('m', 1)] → MB単位で少数第1位まで表示
{pdf@fileSize}[convert_bytes('g', 2)] → GB単位で少数第2位まで表示
striptags htmlタグを取り除きます。
Ver.2.11以降をお使いの場合は raw と併用してください。（例：[raw|striptags]）
base64 base64形式でエンコードします。
md5 ハッシュ値を算出します。
urldecode URLエンコードを元の文字列に戻します。
urlencode 文字列をURLエンコード（UTF-8）します。RFC3986準拠。 ※ 半角スペース → %20に変換 / 半角チルダ → 変換しない
html_entity_decode 実態参照を元の文字列に戻します。
trim4ext 変数から拡張子を除去します。
例：{entry_code}[trim4ext('.html')]
convert 文字列を変換して表示します。（PHPのmb_convert_kana関数に準拠）
例：{title}[convert('a')]
br4alnum 英数字が一定数連続するたびに、任意の文字列を挿入します。
例1：{text}[br4alnum('10')] 10文字ごとに<br />を挿入（デフォルトでbr）
例2：{text}[br4alnum('10', '­')] 10文字ごとに­を挿入（word-break: break-allの代替）
zero_padding 指定の桁数になるように、数字の左側を0（ゼロ）で埋める。
例：{number}[zero_padding('5')] 5桁になるように0で埋める 51 → 00051 に変換
split 正規表現で文字列を分割し指定した順番の文字列を表示する。
例：{hoge}[split(',', 2)] カンマで分割して3番目を表示 a,b,c,d,e → c（添字は0から）
エスケープが必要な記号：@()[].{}*^$|+?-\（「\」または「¥」でエスケープ可）
例：{hoge}[split('\.', 2)]（「.」をエスケープする場合）
contrastColor 指定色（Hex指定 例: #FFFFFF）に載せる文字色として、コントラストが高くなるように、黒系、白系のカラーを返します。

例: {color}[contrastColor] colorの色が濃い場合 #ffffff を返し、薄い場合 #000000 を返します。
例: {color}[contrastColor('#333')] 黒系のカラーの指定ができます。
例: {color}[contrastColor('#333', '#eee')] 黒系、白系のカラー指定をする場合。
entryStatusLabel eid（エントリーID）から下書き、非公開、承認中などのステータスを表示します。

ログインしている時に表示される「エントリーのステータス」はタイトル変数に入っているため「エントリーステータス」のみ表示したい時、使用できます。

使用例: 多言語サイトなどでは、メイン言語以外のタイトルをカスタムフィールドで出力する場合する場合が多いですが、この場合「エントリーステータス」がメイン言語以外で表示できないため、 この校正オプションを利用します。

例: {eid}[entryStatusLabel]
resizeImg 指定したサイズで画像リサイズをします。
指定した横サイズよりも画像幅が小さい場合、横のリサイズはされません。
指定した縦サイズよりも画像高さが小さい場合、縦のリサイズはされません。
例：{image@path}[resizeImg(400,300)] 横400, 縦300でリサイズ。
例：{image@path}[resizeImg(400)] 横400 でアスペクト比を維持してリサイズ。
resizeImgFill resizeImg と同じ仕様になります。
resizeImgFit アスペクト比を維持したまま、指定したサイズで画像が入るようにリサイズをします。
例：{image@path}[resizeImgFit(400,400)] 横400, 縦400でリサイズ。指定したサイズよりも画像が大きく、アスペクト比が違う場合は、余白ができます。
例：{image@path}[resizeImgFit(400,300,'ff0000')] リサイズ後の余白の背景色を指定してリサイズ（jpegのみ）
imageRatioSizeW 画像URLを元に、指定した画像の高さに対する幅を計算します。
例：<img src="{image_path}" width="{image_path}[imageRatioSizeW(150)]" height="150" alt=""> 高さ150pxのときの画像の幅を出力します
imageRatioSizeH 画像URLを元に、指定した画像の幅サイズに対する高さを計算します。
例：<img src="{image_path}" width="150" height="{image_path}[imageRatioSizeH(150)]" alt=""> 幅150pxのときの画像の高さを出力します
buildGlobalVars 変数の中のグローバル変数を展開します。
buildModule 変数中にあるモジュールを展開します。
buildTpl テンプレートエンジンを通し出力します。（グローバル変数やモジュールが解決されます）

acmsパス

acmsパスで指定した任意の条件で、対象のファイルやリンクを読み込みます。

bid ブログのIDを数字で指定します。 例

bid/2/ … BIDが2のブログを指定します
aid エイリアスのIDを数字で指定します。
uid ユーザーのIDを数字で指定します。
cid カテゴリーのIDを数字で指定します。
eid エントリーのIDを数字で指定します。
cmid コメントのIDを数字で指定します。
tbid トラックバックのIDを数字で指定します。
keyword 検索キーワードを指定します。
tag タグを指定します。
複数設定する場合はスラッシュで区切ります。
field フィールドを指定します。 例

field/job/Webデザイン・Web制作・CGI制作/クリエイター・グラフィックデザイナー/and/location/東京23区
order 表示順を指定します。 例

datetime-desc/ … 日時で降順
code-asc/ … コード名で昇順
tpl テンプレートを指定します。
この項目は必ず、パスの最後に記述して下さい。
page ページを指定します。
limit 表示件数を指定します。
span ( - ) 期間を指定します。 例

2009-01/-/2009-02/ … 2009年１月〜２月の記事を指定します。
query クエリストリング指定します。 例

<input type="hidden" name="hoge" value="aaa">
<input type="hidden" name="query[]" value="hoge">
admin 管理ページを指定します。 例

admin=top（ダッシュボード）admin=entry_index（エントリ一覧）

フォームオプション

validator ( v )

フィールドを検証する設定項目です。”validator#required” は “v#required” と省略することができます。

次の例では、”mailaddress” という名前のカスタムフィールドを追加し、正しいメールアドレスであることをチェックします。

例：正しいメールアドレスが入力されているかのチェック

<input name="mailaddress" type="text" value="" />
<input type="hidden" name="field[]" value="mailaddress" />
<input type="hidden" name="mailaddress:validator#email" />
required フィールドに「入力が必須である」という属性を指定します。 ソース 
例）<input type="hidden" name="filedname:v#required" />
minlength フィールドに文字数の下限を指定します。
maxlength フィールドに文字数の上限を指定します。 ソース 
例）<input type="hidden" name="filedname:v#maxLength" value="20" />
min フィールドが数値の時、数値の下限を指定します。
max フィールドが数値の時、数値の上限を指定します。
regex フィールドの内容が "正規表現にマッチ" するかどうかをチェックします。 ソース 
例）<input type="hidden" name="tel:v#regex" value="\d\{2,4\}-\d\{2,4\}-\d\{4\}" />
digits フィールドの内容が "数値" かどうかをチェックします。
email フィールドの内容が "正しいメールアドレス" かどうかをチェックします。
url フィールドの内容が "正しいURL" かどうかをチェックします。
equalTo フィールドの内容が "指定された別のフィールド" と同じかどうかをチェックします。（ソースはパスワードの再確認フォームの例です） ソース 
例）<input name="password" type="text" value="" />
<input type="hidden" name="field[]" value="password" />
<input name="password2" type="text" value="" />
<input type="hidden" name="field[]" value="password2" />
<input type="hidden" name="password2:v#equalTo" value="password" />
dates フィールドの内容が"日付系の校正オプションを適用可能な形式"かどうかチェックします。
適用可能な形式：
(月と日が1桁の場合、2桁目の0は必須ではありません)
1985-08-26、1985/08/26、1985.08.26、s60.8/26、h21.5.11
times 時間系の校正オプションを適用可能な形式かチェック
all_maxChecked チェックボックス等の選択数の上限を指定します。
all_minChecked チェックボックス等の選択数の下限を指定します。
all_justChecked チェックボックス等の選択数を指定します。
duplication 過去に送信されたメールアドレスかどうかをチェックします。フォームIDのログから判定するため、フォームIDである必要があります。 ソース 
例）<input type="hidden" name="email:v#duplication" />
filesize ファイルサイズをチェックします。KBで指定。 ソース 
例）<input type="hidden" name="pdf:v#filesize" value="500" />

converter ( c )

指定されたフィールドを任意の形式に変換します。これは、変換に指定できるオプションPHPのmb_convert_kana関数に依存します。mb_convert_kana関数の仕様にならい、複数のオプションを指定することもできます。詳細は、上記のリファレンスをご確認ください。

次の例ではaddressという名前のカスタムフィールドを追加し、送信時に入力内容の全角英数を半角英数に変換しています。

例：送信時に入力内容の全角英数を半角英数に変換する

<input name="address" type="text" value="" />
<input type="hidden" name="field[]" value="address" />
<input type="hidden" name="address:c" value="a" />
オプション 意味
r 「全角」英字を「半角」に変換します。
R 「半角」英字を「全角」に変換します。
n 「全角」数字を「半角」に変換します。
N 「半角」数字を「全角」に変換します。
a 「全角」英数字を「半角」に変換します。
A 「半角」英数字を「全角」に変換します。
s 「全角」スペースを「半角」に変換します（U+3000 -> U+0020）。
S 「半角」スペースを「全角」に変換します（U+0020 -> U+3000）。
k 「全角カタカナ」を「半角カタカナ」に変換します。
K 「半角カタカナ」を「全角カタカナ」に変換します。
h 「全角ひらがな」を「半角カタカナ」に変換します。
H 「半角カタカナ」を「全角ひらがな」に変換します。
c 「全角カタカナ」を「全角ひらがな」に変換します。
C 「全角ひらがな」を「全角カタカナ」に変換します。
V 濁点付きの文字を一文字に変換します。"K", "H" と共に使用します。

config.server.php

定義名 説明 初期値
DOMAIN システムの基本ドメイン。インストール時に設定されます。 'localhost'
DOMAIN_BASE サブドメイン利用時のサブドメインを除いたドメインを指定。 ''
DB_TYPE 使用するRDBMSの種類。バージョン1.2.0現在はMySQLのみがサポートされます。 'mysql'
DB_HOST データベースのホスト。インストール時に設定されます。 ''
DB_NAME データベースの名前。インストール時に設定されます。 ''
DB_USER データベースのユーザー。インストール時に設定されます。 ''
DB_PASS データベースのパスワード。インストール時に設定されます。 ''
DB_PORT データベースのポート。通常は変更しません。 ''
DB_CHARSET データベースの文字コード。インストール時に設定されます。 ''
DB_CONNECTION_CHARSET データベースへの接続文字コードを指定します。何も指定しない場合は、utf-8が利用されます。
絵文字などを利用する場合は、utf8mb4を指定ください。（データベース側もutf8mb4に変更）
 null
DB_PREFIX a-blog cmsによって作成されるテーブルの接頭辞。インストール時に設定されます。 ''
DB_SLOW_QUERY_TIME ベンチマークモード時にスロウクエリを表示する基準タイムを設定します。 0.3
GETTEXT_TYPE どのようなに国際化するかのオプション。 fix(固定)|auto(ブラウザ設定)|user(ユーザのカスタムフィールドによって) 'auto'
GETTEXT_APPLICATION_RANGE どのページで国際化をするかの設定。admin(管理ページのみ)|login(ログイン時のみ)|all(すべてのページ) 'all'
GETTEXT_DEFAULT_LOCALE デフォルトロケール値。 'ja_JP'
GETTEXT_DOMAIN 国際化時のドメイン。 'messages'
GETTEXT_PATH 国際化ファイルのディレクトリ名。 'lang'
SSL_ENABLE ONで管理ページでSSL/TLS有効になります。 0(1:ON / 0:OFF)
FULLTIME_SSL_ENABLE ONでサイト全体がSSL/TLS有効になります。※有効にする際はSSL_ENABLEもONにする必要があります 0(1:ON / 0:OFF)
COOKIE_SECURE Cookieでセキュア属性を設定するかどうか設定します 0(1:ON / 0:OFF)
COOKIE_HTTPONLY CookieでHTTP ONLY属性を設定するかどうか設定します 1(1:ON / 0:OFF)
HOOK_ENABLE ONでフック機能が有効になります。 0(1:ON / 0:OFF)
RESOLVE_PATH テンプレート上のリンクやリソースの場所を自動で補完します 1(1:ON / 0:OFF)
URL_SUFFIX_SLASH ONでシステムが生成するURLの末尾にスラッシュ( / )が付きます。 1(1:ON / 0:OFF)
SESSION_NAME a-blog cmsのセッション名。 'sid'
REWRITE_FORCE mod_rewrite機能が有効でない場合にも強制的にmod_rewrite用のURLを出力します 1(1:ON / 0:OFF)
MAX_PUBLISHES 同時に生成出来る動的なページのページ数です。キャッシュされているページは除外します。動的に生成しなければならないページのリクエストがこの数を超えると503ページが返されます。この数をむやみに上げすぎるとサーバに負担がかかります。サーバのパフォーマンスにあわせて調整してください。 3
MAX_EXECUTION_TIME プログラムの最大実行時間(秒)。 30
DEFAULT_TIMEZONE デフォルトのタイムゾーンを設定します。 Asia/Tokyo
PHP_SESSION_USE_DB PHPネイティブセッションでDBハンドラを使用するかどうかの設定。 0(1:ON / 0:OFF)
THEMES_DIR テーマディレクトリの場所。 'themes/'
ARCHIVES_DIR アーカイブディレクトリの場所。 'archives/'
REVISON_ARCHIVES_DIR バージョン管理で使用するアーカイブディレクトリの場所。 'archives_rev/'
MEDIA_LIBRARY_DIR メディア管理で使用するアーカイブディレクトリの場所。 'media/'
ARCHIVES_CACHE_SERVER 画像などのURLをここで設定したものに書き換え。(CDNなどで利用) ''
PHP_DIR プログラム(PHP)ディレクトリの場所。 'php/'
JS_DIR プログラム(Javascript)ディレクトリの場所。 'js/'
IMAGES_DIR システムイメージディレクトリの場所。 'images/'
CONFIG_FILE コンフィグの設定ファイルの場所。拡張する場合はこのファイルを編集。 'private/config.sysytem.yaml'
CONFIG_DEFAULT_FILE コンフィグのデフォルト値が格納された設定ファイルの場所。 'private/config.sysytem.default.yaml'
MIME_TYPES_FILE MIMEタイプの定義ファイルの場所 'private/mime.types'
REWRITE_PATH_EXTENSION リンクの書き換えを行う、拡張子を設定。 'pdf|doc|docx|ppt|pptx|xls|xlsx|lzh|zip|rar'
ERROR_LOG_FILE エラーログの出力先を設定。空の場合はOSのシステムログを使用。 ''
BID_SEGMENT ブログID 'bid'
AID_SEGMENT エイリアスID 'aid'
UID_SEGMENT ユーザーID 'uid'
CID_SEGMENT カテゴリーID 'cid'
EID_SEGMENT エントリーID 'eid'
UTID_SEGMENT ユニットID 'utid'
CMID_SEGMENT コメントID 'cmid'
TBID_SEGMENT トラックバックID 'tbid'
KEYWORD_SEGMENT キーワード 'keyword'
TAG_SEGMENT タグ 'tag'
FIELD_SEGMENT フィールド 'field'
ORDER_SEGMENT 並び順 'order'
ALT_SEGMENT オルタネイト 'alt'
TPL_SEGMENT テンプレート 'tpl'
PAGE_SEGMENT ページ 'page'
PROXY_SEGMENT プロキシー 'proxy'
TRACKBACK_SEGMENT トラックバック 'trackback'
SPAN_SEGMENT スパン（期間） 'span'
ADMIN_SEGMENT 管理ページ 'admin'
LOGIN_SEGMENT ログインページ 'login'
SIGNUP_SEGMENT サインアップ（未使用） 'signup'
LIMIT_SEGMENT 表示の上限件数 ( 未使用 ) 'limit'
DOMAIN_SEGMENT ドメイン 'domain'
IOS_APP_UA iOSアプリのユーザーエージェント 'acms_iOS_app'
DEBUG_MODE デバッグモード。ONの間は各種エラーメッセージが表示されます。サイト公開中はOFFに設定してください。 1(1:ON / 0:OFF)
BENCHMARK_MODE ベンチマークモード。ONの間はモジュール実行時間などのベンチマーク情報が表示されます。サイト公開中はOFFに設定してください。 0(1:ON / 0:OFF)

WebP画像対応

Ver. 2.11.22 より、次世代画像フォーマットである「WebP」画像の生成に対応しました。ここでは、WebP画像の利用条件、使用方法について説明します。

対応ブラウザ

  • Chrome
  • FireFox
  • ChroniumベースのEdge
  • Safari（iOS含む） 14 以降
  • https://caniuse.com/#search=webp

利用してるサーバーで WebP画像が生成できるか調査する

以下のような info.php を起き、phpの情報をみて、GD か Imagick の項目で、WebPフォーマットが入っていれば利用可能です。

<?php
  phpinfo();
GDでWebPが使えるか確認

GDでWebPが使えるか確認

ImagickでWebPが使えるか確認

ImagickでWebPが使えるか確認

設定方法

config.system.yaml の確認

config.system.yaml で webp_support が off （default: on）になっていないか確認します。

WebP画像生成確認

カスタムフィールド やユニット、メディアに画像を登録し、 同じファイル名.webp という WebP画像が生成されることを確認します。

ファイル名.webp という画像が生成できているか確認

ファイル名.webp という画像が生成できているか確認

.htaccess

WebP画像は対応していないブラウザもあるため、.htaccessで対応ブラウザだけにWebP画像を返すようにします。

# webpフォーマット画像対応
RewriteCond %{HTTP_ACCEPT} image/webp
RewriteCond %{REQUEST_FILENAME} (.*)\.(jpe?g|png)$
RewriteCond %{REQUEST_FILENAME}\.webp -f
RewriteCond %{QUERY_STRING} !type=original
RewriteRule (.+)\.(jpe?g|png)$ %{REQUEST_FILENAME}.webp [T=image/webp,E=accept:1]
Header append Vary Accept env=REDIRECT_accept
AddType image/webp .webp

Header append Vary Accept env=REDIRECT_accept 
この行はCDNなどによるキャッシュを行う場合、必ず指定してください。指定しないと、対応していないブラウザでもWebP画像が帰ってしまったりします。

WebP画像を使うことによって、画像の容量を大幅に減らすことができます。是非サーバーが対応している場合は、積極的に利用してみましょう。